forked from pattern-lab/patternlab-node
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: pattern wrap classes config and details documentation
Refs: pattern-lab#1432
- Loading branch information
Showing
2 changed files
with
129 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
packages/docs/src/docs/advanced-pattern-wrap-classes.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
--- | ||
title: Pattern Wrap Classes | ||
tags: | ||
- docs | ||
category: advanced | ||
eleventyNavigation: | ||
title: Pattern Wrap Classes | ||
key: advanced | ||
order: 300 | ||
sitemapPriority: '0.8' | ||
--- | ||
|
||
This feature allows you to add a wrapper div with css class(es) around a pattern when shown in the single preview. | ||
If it gets included in another pattern, the wrapper is not added. | ||
|
||
This comes in handy if you, for example, use theming classes to visualize different backgrounds, colors etc. | ||
|
||
## Configuration | ||
|
||
Enable this feature with the configuration options | ||
[patternWrapClassesEnable](/docs/editing-the-configuration-options/#heading-patternwrapclassesenable) and | ||
[patternWrapClassesKey](/docs/editing-the-configuration-options/#heading-patternwrapclasseskey). | ||
|
||
## How does it work? | ||
|
||
Patternlab will look for any "data key" added to the `patternWrapClassesKey` array and adds that | ||
date to the wrapper element classes. | ||
|
||
Data key can be set inside the Markdown or JSON file of any pattern. | ||
|
||
### Example Config | ||
|
||
```json | ||
"patternWrapClassesKey": ["theme-class"] | ||
``` | ||
|
||
## Use in Markdown | ||
|
||
Usage [Documenting Patterns](/docs/documenting-patterns/) | ||
|
||
### my-pattern.md | ||
```markdown | ||
--- | ||
theme-class: my-theme-class | ||
--- | ||
``` | ||
|
||
### Result | ||
```html | ||
<div class="pl-pattern-wrapper-element my-theme-class">...markup of pattern...</div> | ||
``` | ||
|
||
## Use in JSON | ||
|
||
Usage [Creating Pattern-specific Values](/docs/creating-pattern-specific-values/) | ||
|
||
### my-pattern.json | ||
```json | ||
{ | ||
"theme-class": "my-other-theme-class" | ||
} | ||
``` | ||
|
||
### Result | ||
```html | ||
<div class="pl-pattern-wrapper-element my-other-theme-class">...markup of pattern...</div> | ||
``` | ||
|
||
## Pseudo-Patterns | ||
|
||
This will work with pseudo-patterns too ([Using Pseudo-Patterns](/docs/using-pseudo-patterns/)) | ||
|
||
### my-pattern~variant.json | ||
```json | ||
{ | ||
"theme-class": "my-variant-theme-class" | ||
} | ||
``` | ||
|
||
### Result | ||
```html | ||
<div class="pl-pattern-wrapper-element my-variant-theme-class">...markup of pattern...</div> | ||
``` | ||
|
||
## Multiple entries in "patternWrapClassesKey" | ||
|
||
Will result in multiple classes in the wrapper div. | ||
|
||
### Example Config | ||
```json | ||
"patternWrapClassesKey": ["theme-class", "other-class"] | ||
``` | ||
|
||
### my-pattern.json | ||
```json | ||
{ | ||
"theme-class": "theme-class", | ||
"other-class": "some-other-class" | ||
} | ||
``` | ||
|
||
### Result | ||
```html | ||
<div class="pl-pattern-wrapper-element theme-class some-other-class">...markup of pattern...</div> | ||
``` |