https://github.com/rse/style-scope

PostCSS and PostHTML plugins for locally scoping styles
https://github.com/rse/style-scope

css plugin postcss posthtml scope style

Last synced: 1 day ago
JSON representation

PostCSS and PostHTML plugins for locally scoping styles

• Host: GitHub
• URL: https://github.com/rse/style-scope
• Owner: rse
• Created: 2017-04-03T17:57:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T20:43:36.000Z (11 months ago)
• Last Synced: 2025-01-17T20:49:37.659Z (6 days ago)
• Topics: css, plugin, postcss, posthtml, scope, style
• Language: JavaScript
• Homepage: http://npmjs.com/style-scope
• Size: 24.4 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

Style-Scope

===========

PostCSS and PostHTML plugins for locally scoping styles.









About

-----

This is a pair of plugins for the HTML/CSS post-processors

[PostHTML](https://github.com/posthtml/posthtml) and

[PostCSS](http://postcss.org/) to provide a locally scoped style

functionality where the scope of CSS rules is retricted to a group of HTML

elements to prevent their application on deeper nested HTML elements. It is

intended to be used for post-processing CSS and HTML of components in a

Single-Page-Application.

Usage

-----

The following sample...

```js

const posthtml      = require("posthtml")

const postcss       = require("postcss")

const posthtmlScope = require("style-scope/posthtml")

const postcssScope  = require("style-scope/postcss")

const html = `



    


        a1

        


            a2

            a2

        

        a3

    



`


const css = `

/* CSS */

.foo, .bar, .quux {}

@scope s1;

.foo, .bar, .quux {}

@scope s2 {

    .foo {}

    @scope none {

        .bar {}

    }

    .quux {}

}

#foo > .bar[quux] {}

#foo.bar.quux:hover:not(foo, bar, quux) {}

@scope s3;

#foo + .bar[baz='quux'] ~ quux {}

.foo {}

`

posthtml([ posthtmlScope({ rootScope: "sample" }) ])

    .process(html, {})

    .then((result) => { console.log(result.html) })

postcss([ postcssScope({ rootScope: "sample" }) ])

    .process(css, {})

    .then((result) => { console.log(result.css) })

```

...produces the following output:

```



    


        a1

        


            a2

            a2

        

        a3

    



/* CSS */

.foo[scope-sample], .bar[scope-sample], .quux[scope-sample] {}

.foo[scope-s1], .bar[scope-s1], .quux[scope-s1] {}

.foo[scope-s2] {}

.bar {}

.quux[scope-s2] {}

#foo[scope-s1] > .bar[quux][scope-s1] {}

#foo.bar.quux:hover:not(foo[scope-s1], bar[scope-s1], quux[scope-s1])[scope-s1] {}

#foo[scope-s3] + .bar[baz='quux'] ~ quux[scope-s3] {}

.foo[scope-s3] {}

```

License

-------

Copyright (c) 2017-2024 Dr. Ralf S. Engelschall (http://engelschall.com/)

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

"Software"), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be included

in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.