Skip to content

Library of Accessible React Components based on Macmillan Learning CDL

Notifications You must be signed in to change notification settings

jeffprinty/ml-a11y-cdl-components

Repository files navigation

ml-a11y-cdl-components

Components

Links:

Alerts are used the tell the user important information related to their current activity, or to signal a change has occurred to one of their items.

TODO/Considerations

  • CDL does not specify animations, how should alerts appear?
  • Probably needs to have its own state
  • How to manage delay? Allow custom delay?

Props

alertType: string required
content: either element or string required
dismissable: boolean defaults to true

<Alert alertType="alert" dismissable={ true } text={ <div>Text within a div passed as a prop <a href="/">link</a></div> } /><br />
<Alert alertType="warning" dismissable={ false } text="Plain old text" /><br />
<Alert alertType="error" dismissable={ true } text={ <div>Error text <a href="/">link</a></div> } /><br />
<Alert alertType="success" dismissable={ true } text={ <div>Success text <a href="/">link</a></div> } /><br />

[IMAGE]

Links

Todo

  • Text buttons
  • Button group
  • Tab group

Links:

Checkbox

Links

Icon

Links:

Input

Layout

Modal

Links

Links

Toggle

Links

Done

Getting Started

Soon

Installing

How to get a development env running

npm install
cd demo
npm start

Open 0.0.0.0:8080 to view demo server

Running the tests

npm run test

Demo

Run the Demo locally for usage examples or view the demo online

Dependencies

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

  • Jeff Printy - Initial work
  • Phillip Jones - Contributing

About

Library of Accessible React Components based on Macmillan Learning CDL

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published