Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create Tile Component #1

Closed
ItsMeBrianD opened this issue Jul 24, 2020 · 0 comments · Fixed by #2
Closed

Create Tile Component #1

ItsMeBrianD opened this issue Jul 24, 2020 · 0 comments · Fixed by #2
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@ItsMeBrianD
Copy link
Owner

  1. See the UIKit Documentation

  2. Create file structure

    • src/Tile
    • src/Tile/README.md
    • src/Tile/Tile.svelte
  3. Add the needed references.

    • Update src/README.md
      • Add reference to Tile directory (Be sure to include #Tile in the url)
    • Update src/index.js
      • Use existing exports as an example, one blank line before and after your directory addition
  4. Create the story (stories/Tile.stories.js)

  5. Create boilerplate

    • src/Tile/README.md
      • Copy an existing README file and change all references to Tile instead of [Component]
    • Create your <script></script> block
      • Define your props. (These should encompass everything that can change)
  6. Write the markdown

    • Use the uikit documentation as a guide, the component will closely match the example markdown without contents.
  7. 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
  8. Add the width action

  9. Export all prop options from a module context block

  10. Add storybook knobs

    • See other stories for examples
  11. Export storybook npm run commit-docs-dist

  12. Open PR

@ItsMeBrianD ItsMeBrianD added enhancement New feature or request good first issue Good for newcomers labels Jul 24, 2020
@TechSolomon TechSolomon mentioned this issue Jul 26, 2020
3 tasks
ItsMeBrianD added a commit that referenced this issue Jul 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants