Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@sonarsource/echoes-react
Advanced tools
A React implementation of Echoes, Sonar's Design System.
yarn add @sonarsource/echoes-react
Make sure to setup the IntlProvider
from react-intl
at the root of your app. See this page for more information.
Use components from the lib:
import { Checkbox } from '@sonarsource/echoes-react';
See available components and usage in storybook: https://echoes-react.netlify.app/
The lib only provides es module bundle. If you use Jest for your tests (or a similar library) make sure your transform preprocessor goes through echoes-react
to make it runnable on Node.js.
You can do that by adding an exception in your transformIgnorePatterns
, for example:
transformIgnorePatterns: [`/node_modules/(?!@sonarsource/echoes-react)`],
We recommend VSCode to work on this project.
There is a .vscode
folder containing:
settings.template.json
settings.json
You should also set up your vscode to work with the yarn
pnp setup, using the following command: yarn dlx @yarnpkg/sdks vscode
Use the following command to run both the build watcher and the storybook server in dev
mode:
yarn dev
To run tests, run:
yarn test
To build the lib, run:
yarn build
The lib is built on top of some generated files like the design-tokens of the icons fonts. Those generated files are versioned in the src/generated
and i18n
folders.
We generated an optimized version of the material-symbold-rounded font that we use for our icons. The whole font contains thousands of icons and weighs more than 4Mb, so we generate a subset of it containing only the icons we use in the design system, reducing its size to a few Kb.
If you add new icons you must run the following command to generate the new optimized font:
yarn build-fonts
Our raw design tokens files that are created on Figma are stored inside the design-tokens/tokens
folder. We can't use these tokens as is, so we transform them using style-dictionary
to css variable format and store them in the src/generated
folder. We also generate a few other files to help us with typings.
If new design tokens are added to the raw figma file, we must run the following command to generate the new design tokens css variables:
yarn build-tokens
We use the react-intl
library for internationalization. We store our translations in the i18n/keys.json
file. This file is generated based on all the translation keys contained in our components. This file is mainly useful for the products that use the lib to know what keys they should translate.
If you add new translation keys, you must run the following command to generate the new i18n/keys.json
file:
yarn build-intl-keys
Copyright 2023-2024 SonarSource. Licensed under the GNU Lesser General Public License, Version 3.0
FAQs
React implementation of Echoes, SONAR's Design System
The npm package @sonarsource/echoes-react receives a total of 455 weekly downloads. As such, @sonarsource/echoes-react popularity was classified as not popular.
We found that @sonarsource/echoes-react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.