summaryrefslogtreecommitdiff
path: root/node_modules/@csstools/cascade-layer-name-parser/README.md
diff options
context:
space:
mode:
authorlittleblack111 <littleblack11111@gmail.com>2023-10-14 15:05:55 +0800
committerlittleblack111 <littleblack11111@gmail.com>2023-10-14 15:05:55 +0800
commitc06f7ee0a40255214c477e13d9b956a7e07c2900 (patch)
treef5982a568ef8fab865d0142e71c7494fea3e4c1b /node_modules/@csstools/cascade-layer-name-parser/README.md
parent3fd9400d4dccc25aa29b5702216732e0b7542073 (diff)
postcss,(plugins): nanocss, postcss-preset-env
Diffstat (limited to 'node_modules/@csstools/cascade-layer-name-parser/README.md')
-rw-r--r--node_modules/@csstools/cascade-layer-name-parser/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/node_modules/@csstools/cascade-layer-name-parser/README.md b/node_modules/@csstools/cascade-layer-name-parser/README.md
new file mode 100644
index 00000000..44e2111e
--- /dev/null
+++ b/node_modules/@csstools/cascade-layer-name-parser/README.md
@@ -0,0 +1,32 @@
+# Cascade Layer Name Parser
+
+[<img alt="npm version" src="https://img.shields.io/npm/v/@csstools/cascade-layer-name-parser.svg" height="20">][npm-url]
+[<img alt="Build Status" src="https://github.com/csstools/postcss-plugins/workflows/test/badge.svg" height="20">][cli-url]
+[<img alt="Discord" src="https://shields.io/badge/Discord-5865F2?logo=discord&logoColor=white">][discord]
+
+## Usage
+
+Add [Cascade Layer Name Parser] to your project:
+
+```bash
+npm install @csstools/cascade-layer-name-parser @csstools/css-parser-algorithms @csstools/css-tokenizer --save-dev
+```
+
+[Cascade Layer Name Parser] depends on our CSS tokenizer and parser algorithms.
+It must be used together with `@csstools/css-tokenizer` and `@csstools/css-parser-algorithms`.
+
+```ts
+import { parse } from '@csstools/cascade-layer-name-parser';
+
+const layerNames = parse('layer-name, foo.bar');
+layerNames.forEach((layerName) => {
+ console.log(layerName.name()) // "foo.bar"
+ console.log(layerName.segments()) // ["foo", "bar"]
+});
+```
+
+[cli-url]: https://github.com/csstools/postcss-plugins/actions/workflows/test.yml?query=workflow/test
+[discord]: https://discord.gg/bUadyRwkJS
+[npm-url]: https://www.npmjs.com/package/@csstools/cascade-layer-name-parser
+
+[Cascade Layer Name Parser]: https://github.com/csstools/postcss-plugins/tree/main/packages/cascade-layer-name-parser