@quid/theme
v4.11.6
Published
Colors, fonts and other styling related resources, consumable by Emotion
Downloads
1,457
Readme
This package provides a set of colors, sizes, and font styles, used to style the applications created at Quid.
The named ThemeProvider
export of the package is an Emotion theme provider
that should wrap any application to make sure the other Quid components
are properly styled with the resources provided by this package.
Additionally, you can import the colors
, sizes
, textStyles
, and themes
named exports to directly reference the variables.
Installation
npm install --save @quid/theme
# or
yarn add @quid/theme
Usage
Wrap your component with ThemeProvider
and, optionally, define the desired
theme (light
or dark
, light
is default):
import { ThemeProvider } from '@quid/theme';
<ThemeProvider theme="light">
<Button>I'll use the light theme</Button>
</ThemeProvider>;
Once a styled component is wrapped by the ThemeProvider, it can access
the current theme from the props.theme
property.
Additionally, inside the theme object, you will find a current
property
that will be set to light
or dark
depending by the active theme.
This can be useful to conditionally style a component depending by its theme.
import styled from '@emotion/styled/macro';
import { ThemeProvider } from '@quid/theme';
const Test = styled.span`
color: ${props => props.theme.primary};
background-color: ${props =>
props.theme.current === 'dark' ? 'black' : 'white'};
`;
<ThemeProvider theme="light">
<Test>Foobar</Test>
</ThemeProvider>;
withFallback
The withFallback
function is available to make it possible to create
your components and not have to worry of the case when no ThemeProvider
is defined to provide a theme to your component.
It will take care to set the light theme as default theme if no one is set.
import styled from '@emotion/styled/macro';
import { withFallback as wf } from '@quid/theme';
const Button = styled.button`
/* primary will always be defined no metter what */
color: ${wf(props => props.theme.primary)};
`;
textStyles
This utility will provide a set of CSS-in-JS compatible rules to style a text according to the Quid UI guidelines.
The available styles are:
xlarge
,large
,normal
(text sizes)title
,body
(text sizes with serif font family)bold
,regular
(font weight)secondary
,disabled
,link
,highlighted
(text color)
import styled from '@emotion/styled/macro';
import { textStyles } from '@quid/theme';
// This paragraph will have bold text, with the secondary text color
const Paragraph = styled.p`
${textStyles('bold', 'secondary')};
`;
Font Faces
This package exposes two font-faces, IBM Plex (Sans and Serif), and the iconic Quid Icons.
The first is used as font family of all our texts, while the second is an iconic font family used to provide our icons.
You can import both of them in your project with:
import '@quid/theme/fonts/index.css';
Or singularly with:
import '@quid/theme/fonts/ibmplex/index.css';
import '@quid/theme/fonts/icons/index.css';
Once imported, they will be globally available for all the consumer components.