Welcome to SvARIA

A comprehensive component library built from the ground-up for Svelte offering plug-and-play ARIA-compliant components and features to help your project meet and exceed accessibility standards while streamlining the design process.

To install SvARIA in your project, run:

    `npm install svaria-toolkit`

SvARIA has default components styled with Tailwind. To use our default styles, you must install Tailwind into your project. To configure Tailwind to work with our components, node modules must be included in the tailwind config:

content: [ "./src/**/*.{html,js,svelte,ts}", "./node_modules/your-project-name/**/*.{html,js,svelte,ts}", ],

Now you are ready to import our components into your project!

For comprehensive docs, see SvARIA.

you can also check out the SvARIA GitHub

As a preliminary example, this is how to import and customize the button component:

import { Button } from 'svaria-toolkit'

We designed our components to mimic the behavior of HTML tags as closely as possible, with some minor exceptions. To render the component, use the same syntax as an HTML element.

<Button/>

All SvARIA components are fully customizable by accessing the props on each component.

<Button contents="example button" className="bg-red-500"/>

This will create a button labeled "example button" with a red background.

You can also style using regular CSS and access the className on the component. See the documentation for each component on our splash page to access any property name you want to access.

Another benefit of our toolkit is the ARIA checker tool.

This tool is used to check the color contrast using wcag standards and aria labels on appropriate compoents to ensure that components are meeting standards.

in order for the background checks to run, declare the following environmental variable

VITE_SVARIA_MODE="debug"

The ARIA checks will run on all SvARIA components to ensure that as you edit the components, they stay within the parameters of ARIA compliance.

You can also add the checks to any component that is not in our library by adding the ARIA check to your components.

import {colorContrastCheck, parentColorContrastCheck} from 'svaria-toolkit'

<div use:colorContrastCheck use:parentColorContrastCheck > </div>

find the team on linkedin

Jewel Clark Josh Lilienthal Elizabeth Sinclair Nicolette Sooker