React components
Shared react styled components for all the Zopa projects.
This repo contains 2 things at the same time:
-
The Typescript library for the react components
-
Documentation for the components managed with React-styleguidist
Migrating from version 3
There are a number of breaking changes which will need to be addressed when upgrading from Zopa React Components v3 to v4.
The migration guide will walk you through the major changes such as colours and typography.
Installation
$ git clone https://github.com/zopaUK/react-components.git
$ pnpm i
Running the project
Execute the development environment:
$ pnpm dev
The docs will run at localhost:6060.
Motivation
The aim of this project is to share with the frontend community how we code in Zopa.
We think it might be useful for someone who wants to start a new react components library and want to re-use some of our code.
Types
You can access typings for specific components under @zopauk/react-components/types:
import { Button } from '@zopauk/react-components';
import { IButtonProps } from '@zopauk/react-components/types/components/atoms/Button';To inspect the folder structure within @zopauk/react-components/types you can run yarn compile:types and navigate the generated types/ folder in the project root.
Contributing
In case you want to contribute to this library, please have a look at our contributing guidelines 🙌🏼
License
This repository is MIT-licensed.
Trade marks
No permission is granted to use the trade names, trade marks, service marks, or product names of Zopa, except as required for reasonable and customary use in describing the origin of this library and reproducing the content of the notice in the license.
Fonts
Zopa uses Open Sans in its sites and applications. If you want to make use of this font outside of Zopa, you will need to license it directly from Google Fonts.