Have ideas to improve npm?Join in the discussion! »

    @wedgekit/a11y

    3.0.3 • Public • Published

    WedgeKit Accessibility

    Accessibility components and helpers to run alongside WedgeKit.

    Getting Started

    WedgeKit A11y is meant designed to provide helpful packages for creating applications that are accessible to all peoples in a consistent and predictable way.

    Importing A11y

    In order to take advantage of some of A11y's components, you will need to import the compiled css for this library.

    import '@wedgekit/a11y/dist/a11y.css';
    

    If you're using WedgeKit, it is recommended that this be imported immediately after the wedgekit.css import.

    A11y Provider

    Under the hood A11y uses redux to manage some state that needs to be persisted across your application. In order to use A11y, you'll need to import the A11yProvider and wrap your application with it.

    import { A11yProvider } from '@wedgekit/a11y';
    
    export default class App extends React.Component {
      ...
    
      render() {
        return (
          <A11yProvider>
            <YourApplicationComponents />
          </A11yProvider>
        )
      }
    }
    

    Versioning

    A11y conforms to the Semver spec for versioning. The library is versioned separately from @wedgekit/core. Check out the CHANGELOG to see what's changed.

    Local Development

    For most development purposes, symlinking @dmsi/components with a consuming package should be sufficient. However in certain cases the developer may have trouble symlinking to packages with competing dependency versions. In this case you may run yarn publish:test, which will publish a tc version for local development. The package must be updated to a major/minor/patch/rc version before being merged into develop.

    Keywords

    none

    Install

    npm i @wedgekit/a11y

    DownloadsWeekly Downloads

    68

    Version

    3.0.3

    License

    ISC

    Unpacked Size

    27.9 kB

    Total Files

    4

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar