Skip to content

Styleguidist Styleguide Travis build status shield NPM release version shield Github Release version shield NPM Licence shield

Cozy UI

CSS classes and React components designed to build Cozy apps.

If you plan to build a webapp to run on Cozy, you’ll probably want to use a simple and elegant solution to build your interfaces without the mess of dealing with complex markup and CSS. Then Cozy UI is here for you!

Cozy UI relies heavily on Material UI v4 and it can be useful to know how it works.

React components (styleguidist)

Check out UI components to see how to use ready made React components.

CSS Styleguide

Check the styleguide to see all the variables, mixins, classes, utilities and how to use them with only CSS classes.

Usage

As a Components library

Add Cozy UI to a dependency to your project.

yarn add cozy-ui

If you use the transpiled components (from cozy-ui/transpiled/react), you need to import the stylesheet (once):

import Button from 'cozy-ui/transpiled/react/Button'
import 'cozy-ui/transpiled/react/stylesheet.css'

<Button />

You’re now ready to use Cozy UI’s React components

Utility classes

React components only come with the needed style, nothing more, but you may need some more utility classes to build your apps.

To do so you have at your disposal a special CSS build cozy-ui.utils.min.css that you can add like this:

import 'cozy-ui/dist/cozy-ui.utils.min.css'

As a vanilla CSS library (deprecated)

The entire library is also available as a good ol’ CSS library. You can simply add it to your app by linking the distributed minified file.

<link media="all" rel="stylesheet" href=“cozy-ui/dist/cozy-ui.min.css" />

Develop on Cozy UI

If you want to develop inside cozy-ui, you need a local version cozy-ui.

git clone git@github.com:cozy/cozy-ui.git

Install

First nvm use (to set node version as defined in .nvmrc) then yarn install

Develop inside the styleguidist

It is convenient when modifying a component to use the styleguide site.

yarn start # Transpile the files in watch mode
yarn build:css:all # Build CSS files needed by the documentation
yarn start:doc # Run the styleguide in watch mode

Add a component

If you want to add a new component, you must follow these steps:

  • Add the new component in /react folder with its README.md file
  • Expose it in the API by adding it in react/index.js
  • Add it in the documentation by modifying docs/styleguide.config.js
  • If necessary you can add snapshots for it by modifying react/examples.spec.jsx and updating them yarn build && yarn test -u
  • Remember to propagate the possible ref with React.forwardRef. See forwardRef documentation

Rename/Move a component

When renaming or moving a Cozy-UI component, it may cause a breaking change. In this case, you should provide a codemod as much as possible to fix it.

Guidelines for component development

  • Use material UI whenever possible
  • Override material UI components inside makeOverrides.js when necessary
  • Avoid stylus to style new components based on MUI and prefer /helpers/makeStyles
  • Use semantic variables for colors from stylus/settings/palette.styl, or color from theme objects in makeStyles

Add an icon

If you want to add a new icon to cozy-ui, you must follow these steps:

  • First verify that the SVG doesn’t have any fill or fill-opacity properties. Remove them if necessary
  • Add the SVG in the assets/icons/[ui || illus] folder
  • Optimize it with yarn svgo assets/icons/[ui || illus]/[new icon file name]
  • Generate the react component by running yarn makeSvgr assets/icons/[ui || illus]/[new icon file name]
  • Update the documentation by adding the icon in react/Icon/Readme.md inside SVGr icons and Available UI icons sections
  • Don’t forget to check the icon’s color on different theme (inverted, etc.)
  • Update the tests by running yarn sprite && yarn build && yarn test -u

Develop inside an app

Sometimes, you want to develop on a component, from the context of an app. Then you need to link cozy-ui with yarn link. Since cozy-ui is transpiled, when linking you must first yarn release. If you change the icons, or the palette, you must run yarn release again.

cd cozy-ui
yarn release # if first time
yarn link
yarn start # Launch transpilation
yarn release # if you change icons or palette

Then in your application folder, you can link to your local Cozy UI. You can use rlink instead of yarn link. It will prevent common build problems due to module resolution inside symlinked folders. If your application doesn’t use cozy-ui directly as dependency but through a library, you have to use rlink inside your application folder, not inside the library’s one. rlink only copies the build and not the node_modules of cozy-ui, so you have to install a version of cozy-ui before making a rlink.

cd my-app
rlink cozy-ui # Prefer rlink to yarn link
yarn start

All your modifications in your local Cozy UI will now be visible in your application!

Making a demo when creating a pull request

When sending a PR, if your changes have graphic impacts, it is useful for the reviewers if you have deployed a version of the styleguidist containing your changes to your fork’s repository. Don’t forget to change USERNAME by yours.

yarn build
yarn build:css:all
yarn build:doc
yarn deploy:doc --repo git@github.com:USERNAME/cozy-ui.git

⚠️ If the deploy:doc failed, you need to checkout your dev branch by doing git checkout -

Unit testing

Be aware that snapshots in unit tests use the transpiled version of cozy-ui. Therefore if you make changes and need to update the snapshots, you need to transpile first.

yarn build && yarn test -u

We suggest to use @testing-library/react over enzyme for tests. We have historically used enzyme but we prefer the philosophy behind testing-library since it pushes to test for what the user sees.

For complex components, we expose testing helpers in the testing file in their respective folders.

import { getCloseButton, getAllDialogs } from 'cozy-ui/transpiled/react/CozyDialogs/testing'

it('should close dialog', () => {
  const onClose = jest.fn()
  const root = render(<MyApp onCloseDialog={onClose} />)
  const dialog = getDialog(root)
  const closeBtn = getCloseButton(dialog)
  fireEvent.click(closeBtn)
  expect(onClose).toHaveBeenCalled()
})

UI regression testing

Components in cozy-ui are showcased with React Styleguidist. To prevent UI regressions, for each PR, each component is screenshotted and compared to the master version to find any regression (thanks Argos !).

If your app uses React Styleguidist, cozy-ui provides rsg-screenshots, a CLI tool to take screenshots of your components (uses Puppeteer under the hood).

yarn add cozy-ui # The rsg-screenshots binary is now installed
yarn build:doc:react # Build our styleguide, the output directory is docs/react
rsg-screenshots --screenshot-dir screenshots/ --styleguide-dir docs/react # Each component in the styleguide will be screenshotted and saved inside the screenshots/ directory

See our travis configuration for more information.

License

Cozy UI is developed by Cozy Cloud and distributed under the MIT license.

What is Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.

Community

You can reach the Cozy Community by: