Wave

Documentation

Our documentation site lives at https://wave.free-now.com/. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

Installation

npm install @freenow/wave

or

yarn add @freenow/wave

Getting started

After installing Wave as dependency, there are some extra steps to get the styles in place:

• Make sure to install the peerDependencies (including styled-components)
• Check that you don't have any pre-existing global styles that might override/clash with the styles shipped with the components (ex.: a { color: #ffeeaa })
• Make sure to add the desired Color Scheme component to your React tree, to get the CSS variables loaded (more details)

import { ModernColors } from '@freenow/wave'; // blue primary color

ReactDOM.createRoot(document.getElementById('root')!).render(
    <React.StrictMode>
        <ModernColors />
        <App />
    </React.StrictMode>
);

Contributing

Thanks for being willing to contribute! Please read the CONTRIBUTING.md doc

Have doubts?

Please don't hesitate to let know us what are your doubts, what can be improved or what is difficult for you to grasp from the documentation. Open issues to start the conversation!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!