Welcome to The Times Graphics Components, a collection of React-based components designed for interactive graphics and data visualizations.
This library requires React 19 or higher.
Please make sure your project is using React 19+ to avoid runtime errors related to JSX transformations.
To install the dependencies, run:
yarn install
This package is published to GitHub Packages under the @times
scope, and is intended for internal use by teams at The Times / NewsCorp only.
To install this package locally, you need:
- A GitHub personal access token (classic) with
read:packages
permission - A
.npmrc
file configured like this:
@times:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN
registry=https://registry.npmjs.org/
To start the Storybook environment:
yarn storybook
To deploy Storybook to GitHub Pages:
yarn deploy-storybook
We welcome contributions! To contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch
- Run ESLint and fix issues before committing:
yarn lint
- Make your changes and commit them::
git commit -m "Add new feature"
- Push to your branch::
git push origin feature-branch
- Open a pull request on GitHub.