-
Notifications
You must be signed in to change notification settings - Fork 10
template component
Drew Jones edited this page Jan 26, 2021
·
1 revision
---
description: [Atom / Molecule / Organism] | [insert component] component.
---
import { Storybook } from '../../includes/storybook.js'
## Introduction
> [Component introduction]
[Component description]
## Content guidance
| Key | Field type | Guidelines |
| :--- | :--- | :--- |
| | | |
### Image guidance
| Component | Variant | Ratio | Dimensions | Size | Type | Placeholder |
| :--- | :--- | :--- | :--- | :--- | :--- | :--- |
| ` `| ` ` | | | | | |
## Best practice
| π Do's | π Don'ts |
| :--- | :--- |
| | |
| | |
### Considerations of best practice
* [Best practice]
## Usage
To see examples visit [Storybook](https://www.britishgas.co.uk/nucleus/demo/index.html?path=/story/ns-component--default).
<Storybook story="ns-component--default"></Storybook>
## Component Relationship
| **Relationship** | |
| :--- | :--- |
| **Does it live in a panel?** | β
β Yes/No |
| **Does it live inside other components?** | β
β Yes/No - `ns-` |
| **What layout classes can be used?** | None `splash` `splish` `splosh` |
## Specification
| Attribute | Type | Default | Options | Description |
| :--- | :--- | :--- | :--- | :--- |
| ` ` | ` ` | | |
| Event | Description |
| :--- | :--- |
| ` ` | |
| Slots | Type |
| :--- | :--- |
| ` ` | ` ` |
## Specification notes
[Include any notes relevant to the specification for this component]
## Feedback
* Do you have insights or concerns to share? You can raise an issue via [Github bugs](https://github.com/ConnectedHomes/nucleus/issues/new?assignees=&labels=Bug&template=a--bug-report.md&title=[bug]%20[ns-component]).
* See all the issues already raised via [Github issues](https://github.com/connectedHomes/nucleus/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3ABug+[ns-component])
π© π π¦ You can also contact the team on Slack on the `#product-nucleus` channel!
## Related links
* [Related links]