Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

astro-css-components

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

astro-css-components

CSS Components for Astro

  • 0.3.1
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

astro-css-components

⚠️ Very early in development, more of a proof of concept than a real thing at the moment ⚠️

Add "CSS Components" support to Astro, inspired by eleventy-assets. This allows you to for instance, add page specific CSS. In my personal blog, I use it to add the CSS needed for syntax coloring only to the page that have code in them

The API is currently.. not very good. Use at your own caution - it should works, however

Usage

Page.astro

---
import BaseLayout from "BaseLayout.astro"
import { CSSComponent } from "astro-css-components"
---

<CSSComponent register={{ name: "should-be-red", content: ".should-be-red {color: red;}" }} />

<BaseLayout>
  <article>
    <div class="should-be-red">My super text</div>
  </article>
</BaseLayout>

BaseLayout.astro

---
import { CSSComponent } from "astro-css-components"
---

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>

    <CSSComponent getForURL />
</head>
<body>
    <slot />q
</body>
</html>

Result

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>

    <style>.should-be-red {color: red;}</style>
</head>
<body>
  <article>
    <div class="should-be-red">My super text</div>
  </article>
</body>
</html>

API

The CSSComponent component takes the following props:

register

Used to register a new component, it takes an object with the following attributes:

  • name: Name of your component
  • content: CSS style your component has

OR

  • contentFile: File which contain your CSS, path must be relative from the root of your project

Unless used with global, the component will be tied to the current URL

Examples:

<CSSComponent register={{ name: "should-be-red", content: ".should-be-red {color: red;}" }} />
<CSSComponent register={{ name: "code", contentFile: "src/theme/css/modules/code.css" }} />
global

By adding this props, you can make the component global, this mean you can call it from everywhere using getByName

Example:

<CSSComponent global register={{ name: "should-be-blue", content: ".should-be-blue {color: blue;}" }} />
conditional

By adding this props, you can only register the component when a certain condition is met

Example:

<CSSComponent register={{ name: "should-be-orange", content: ".should-be-orange {color: orange;}" }} conditional={page.loadCSSModules.includes("orange")} />

getForURL

Get the components for the current URL, this get all the components registered for the current URL, to get a specific component, use getByName

Example:

<CSSComponent getForURL />

getByName

Get a specific component by name, this look in both the library for the current url and the global one

Example:

<CSSComponent getByName="should-be-yellow" />

Keywords

FAQs

Package last updated on 11 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc