diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/components.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/api/components.md b/docs/api/components.md new file mode 100644 index 0000000..77f1bb1 --- /dev/null +++ b/docs/api/components.md @@ -0,0 +1,12 @@ + + + +### Roles + +| Role | Description | Props | +| ---- | ----------- | ----- | +| `summary:container` | DIV container for the whole summary | `{ summary: Summary }` | +| `summary:parts` | DIV container for summary's parts | `{ parts: List<SummaryPart> }` | +| `summary:part` | DIV for a specific part | `{ part: SummaryPart }` | +| `summary:articles` | UL container for a part's articles | `{ articles: List<SummaryArticle> }` | +| `summary:article` | LI for a specific article | `{ article: SummaryArticle }` | |