@thumbtack/thumbprint-scss
v4.0.3
Published
CSS and Sass mixins for building Thumbtack UI
Downloads
1,908
Keywords
Readme
Thumbprint SCSS
This package contains the SCSS components and mixins. It distributes a few files:
components.css
: This is a compiled CSS file of all Thumbprint SCSS components, for example, buttons, type, and form elements. It is primarly used for projects that do not use React.mixins.scss
: This is a rollup of all Thumbprint mixins used by the SCSS components and includes our breakpoints.alert.css
,avatar.css
,button.css
, etc.: These files are published so that consumers can require individual files if needed.
See the Thumbprint Components section for full documentation.
Installation
yarn add @thumbtack/thumbprint-scss
Use from a CDN
The CSS for Thumbprint SCSS components is hosted on the unpkg CDN. You can include it in a link tag.
<link
rel="stylesheet"
type="text/css"
href="https://unpkg.com/@thumbtack/thumbprint-scss@^0.1.1/components.css"
/>
For best results, change the version number to the latest version of the package.
Use in SCSS
This is required if using breakpoints or component mixins in your SCSS:
@import '[node_modules path]/@thumbtack/thumbprint-scss/mixins
For projects that want to compile Thumbprint CSS components along with other SCSS files, include this CSS file:
@import '[node_modules path]/@thumbtack/thumbprint-scss/components
You can import a single component (button.css
, for example) with:
@import '[node_modules path]/@thumbtack/thumbprint-scss/button
Tip: You can use Sass's
includePaths
ornode-sass-tilde-importer
if you don't want to include[node_modules path]/
in the imports.
Use in JavaScript
You can import all Thumbprint components (classes starting with tp-*
) in JavaScript with this import:
import '@thumbtack/thumbprint-scss';
You can import specific components as well:
import '@thumbtack/thumbprint-scss/button.css';
import '@thumbtack/thumbprint-scss/input.css';
This works in development environments that support importing CSS files in JavaScript. It works without any additional configuration in Create React App, Gatsby, and Next.js.