-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(docs): generate spec for multiple component
- Loading branch information
1 parent
cc77a5f
commit 96cf6fd
Showing
11 changed files
with
78 additions
and
44 deletions.
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
25 changes: 25 additions & 0 deletions
25
packages/components/accordion/documentation/specifications/accordion-group/spec.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,25 @@ | ||
* [**Interfaces**](#interfaces) | ||
* [**Classes**](#classes) | ||
|
||
## Interfaces | ||
|
||
### OdsAccordionGroupMethod | ||
|name | Type | Required | Default | Description| | ||
|---|---|:---:|---|---| | ||
|**`registerAccordion`** | _void_ | ✴️ | | | | ||
|**`unRegisterAccordion`** | _void_ | ✴️ | | | | ||
|
||
## Classes | ||
|
||
### OsdsAccordionGroup | ||
#### Methods | ||
> **registerAccordion**(`accordion`: `OsdsAccordion`) => `Promise<void>` | ||
Name | Type | Description | ||
---|---|--- | ||
**accordion** | `OsdsAccordion` | | ||
> **unRegisterAccordion**(`accordion`: `OsdsAccordion`) => `Promise<void>` | ||
Name | Type | Description | ||
---|---|--- | ||
**accordion** | `OsdsAccordion` | |
File renamed without changes.
12 changes: 12 additions & 0 deletions
12
...documentation/specifications/accordion-group/specifications-accordion-group.mdx
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,12 @@ | ||
import {Description} from '@storybook/addon-docs'; | ||
import Specs from './spec.md'; | ||
import SpecsAccordionGroupContents from './specifications-accordion-group-contents.mdx'; | ||
|
||
|
||
## Description | ||
The accordion group component is an invisible component which is a container of several [Accordions](?path=/docs/ui-components-accordion-accordion-atom-specifications--page) | ||
|
||
<Description>{Specs}</Description> | ||
|
||
## Contents | ||
<SpecsAccordionGroupContents /> |
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
File renamed without changes.
File renamed without changes.
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
2 changes: 1 addition & 1 deletion
2
...k/stories/components/accordion-group/accordion-group.specifications.stories.mdx
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
2 changes: 1 addition & 1 deletion
2
...ges/storybook/stories/components/accordion/accordion.specifications.stories.mdx
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
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