Skip to content

AronssonFredrik/svea

Repository files navigation

Svea

npm Coverage Status Build Status

Component Library for Svelte v3, documented on Storybook.

Get started

Install the dependencies...

npm install svea

Accessibility

Following a philosophy of using built in web- and browser-standards and thereby not overwriting or recreating a11y support. The goal is to follow WCAG of level AA.

Do's:

✔️ Using the HTML5 tags semantically

✔️ Supporting aria-attributes, read guidelines here

Don't:

Overwrite standardise keyboard navigation

Overwrite focus-outline

List of A11y interactions

Component Keystroke Notes
Button enter or space activates the button

Continuously updated as components are created

Follows guidelines here

Development instructions (for working in project)

Keeping up with changelog

Commit Messages should follow following standards:

type(category): description [flags]

Where type is one of the following:

  • breaking
  • build
  • ci
  • chore
  • docs
  • feat
  • fix
  • other
  • perf
  • refactor
  • revert
  • style
  • test

Working locally

Begin by open it in localhost:

npm run autobuild

npm run start:dev

Working with storybook

To start the storybook, follow the process:

# run whenever changes are made to the components
npm run build

npm run storybook

When done, npm run build-storybook can be used to release Storybook

Release instructions

To be continued (..)