https://github.com/esri/calcite-base
Tokens, mixins, and other Sass utilities for Esri's Calcite Design System
https://github.com/esri/calcite-base
calcite css design mixins sass style
Last synced: 27 days ago
JSON representation
Tokens, mixins, and other Sass utilities for Esri's Calcite Design System
- Host: GitHub
- URL: https://github.com/esri/calcite-base
- Owner: Esri
- Created: 2019-04-01T17:37:05.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-30T19:23:23.000Z (about 2 years ago)
- Last Synced: 2025-04-24T05:11:42.681Z (27 days ago)
- Topics: calcite, css, design, mixins, sass, style
- Language: JavaScript
- Homepage: https://esri.github.io/calcite-base/
- Size: 806 KB
- Stars: 11
- Watchers: 384
- Forks: 4
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Calcite Base
The calcite-base repository holds the variables and mixins used in Calcite Components. This includes resources regarding:
- motion (easing functions, transitions)
- type (font stacks, sizing, spacing mixins)
- reponsive design (breakpoints, respond-to mixins)
- utilities (clearfix, show/hide, etc)
- shadow (defined levels of depth)
- spacing (standardized vertical/horizontal spacing units)
## Install
If you use npm, installation is as easy as:
```
npm install @esri/calcite-base
```
You can also [download the latest release manually](https://github.com/Esri/calcite-base/releases).
## Use
In a Sass project, simply import calcite-base into your project and use the variables/mixins:
```scss
@import "./node_modules/@esri/calcite-base/dist/_index.scss";
.myClass {
@include font-size(-1);
}
```
If you only require certain mixins, you can import each section directly as well:
```scss
@import "./node_modules/@esri/calcite-base/dist/_type.scss";
.myClass {
@include avenir-light();
@include font-size(-1);
@include leading(2);
@include tracking(166);
@include word-spacing(200);
}
```
### Custom Properties
If you are using PostCSS (or standard CSS) there are a series of files which declare the variables utilizing [custom properties](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) (CSS Variables). You can use these along with something like the [postcss-custom-properties](https://github.com/postcss/postcss-custom-properties) library to utilize the base colors, styles, etc in your postcss project:
```css
@import "./node_modules/@esri/calcite-base/dist/variables.css";
.myClass {
box-shadow: var(--shadow-1);
}
```
### Focus State Styling
The included focus state styling mixins rely on a `--calcite-ui-blue-1` variable from `calcite-colors`. You can [find the Calcite Colors repository on GitHub](https://github.com/Esri/calcite-colors).
### JavaScript
If you need some of these values and are using a CSS-in-JS approach, you can import them from the JavaScript file using ES6 modules:
```js
import {avenirLight} from "@esri/calcite-base";
console.log(avenirLight); // '"Avenir Next", "Avenir", "Helvetica Neue", sans-serif'
```
Note when using partial imports like this, the hyphenated variables become camel case.
## Licensing
COPYRIGHT © 2020 Esri
All rights reserved under the copyright laws of the United States
and applicable international laws, treaties, and conventions.
This material is licensed for use under the Esri Master License
Agreement (MLA), and is bound by the terms of that agreement.
You may redistribute and use this code without modification,
provided you adhere to the terms of the MLA and include this
copyright notice.
See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
For additional information, contact:
Environmental Systems Research Institute, Inc.
Attn: Contracts and Legal Services Department
380 New York Street
Redlands, California, USA 92373
USA
email: [email protected]
## Contributing
Please read the [contribute document](CONTRIBUTING.md).