Closed
Description
-
See the UIKit Documentation
-
Create file structure
src/Tile
src/Tile/README.md
src/Tile/Tile.svelte
-
Add the needed references.
- Update
src/README.md
- Add reference to Tile directory (Be sure to include
#Tile
in the url)
- Add reference to Tile directory (Be sure to include
- Update
src/index.js
- Use existing exports as an example, one blank line before and after your directory addition
- Update
-
Create the story (
stories/Tile.stories.js
)- Use others as an example
- See also storybook docs
-
Create boilerplate
src/Tile/README.md
- Copy an existing README file and change all references to
Tile
instead of[Component]
- Copy an existing README file and change all references to
- Create your
<script></script>
block- Define your props. (These should encompass everything that can change)
-
Write the markdown
- Use the uikit documentation as a guide, the component will closely match the example markdown without contents.
-
Create class logic
- See other components as an example, anywhere that
classes
is being used - Ensure that invalid inputs are defaulted to a valid input
- See other components as an example, anywhere that
-
Add the width action
- Again see other components for an example (
use:uk_width
) - See also svelte documentation
- Again see other components for an example (
-
Export all prop options from a module context block
-
Add storybook knobs
- See other stories for examples
-
Export storybook
npm run commit-docs-dist
-
Open PR