@new-ui/foundations
Advanced tools
Comparing version 0.0.9 to 0.1.0
{ | ||
"name": "@new-ui/foundations", | ||
"version": "0.0.9", | ||
"version": "0.1.0", | ||
"description": "New UI Foundations", | ||
@@ -32,3 +32,4 @@ "source": "src/index.scss", | ||
"spacing-blocks", | ||
"reset" | ||
"reset", | ||
"new" | ||
], | ||
@@ -42,13 +43,13 @@ "author": "@planetabhi", | ||
"devDependencies": { | ||
"@parcel/transformer-sass": "^2.12.0", | ||
"@parcel/transformer-sass": "^2.13.3", | ||
"autoprefixer": "^10.4.20", | ||
"parcel": "^2.12.0" | ||
"parcel": "^2.13.3" | ||
}, | ||
"dependencies": { | ||
"@new-ui/colors": "^1.3.0", | ||
"@new-ui/effects": "^0.1.0", | ||
"@new-ui/reset": "^0.0.3", | ||
"@new-ui/spacings": "^0.1.1", | ||
"@new-ui/effects": "^0.1.3", | ||
"@new-ui/reset": "^0.0.5", | ||
"@new-ui/spacings": "^0.1.3", | ||
"@new-ui/typography": "^0.1.6" | ||
} | ||
} |
# New UI Foundations | ||
## Install | ||
Install New UI Foundations from your terminal via npm. | ||
``` | ||
npm i @new-ui/foundations | ||
``` | ||
To get started quickly, you can use the CDN files. | ||
```html | ||
<!-- Place this at the html head --> | ||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@new-ui/foundations@<version>/dist/index.css"> | ||
``` | ||
## Usage | ||
```scss | ||
// Place this at the top of your SCSS/CSS file | ||
@import "@new-ui/foundations"; | ||
``` | ||
## Usage Guide | ||
- Tokens defined in the figma file matches variables declared in CSS | ||
- All classes associated with the design system are prefixed with a global namespace followed by a hyphen: `nu-` | ||
- In addition to a global namespace, we added prefixes to each class to make it more apparent what job that class is doing using BEM syntax | ||
* `c-` for UI components, such as `.nu-c-h1` or `.nu-c-card` | ||
* `l-` for layout-related styles, such as `.nu-l-grid__item` or `.nu-l--two-column` | ||
* `u-` for utilities, such as `.nu-u-mb-<spacing-token>` or `.nu-u-margin-bottom-pt2` | ||
* `is-` and has- for specific states, such as `.nu-is-active` or `.nu-is-disabled`. These state-based classes - would apply to | ||
* `js-` for targeting JavaScript-specific functionality, such as `.js-modal-trigger`. No styles are bound to these classes; they’re reserved for behavior only. For most cases, these `js-` classes would toggle - state-based classes to an element. | ||
## Guides | ||
- [Get a Figma copy](https://www.figma.com/community/file/1325646289622213496/new-ui) | ||
- [Read our getting started guide](https://new-ui.com/docs/getting-started/installation) | ||
[Getting started guide](https://new-ui.com/docs/getting-started/installation) ٩( ᐕ)و |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
179394
5
3
+ Added@new-ui/reset@0.0.5(transitive)
- Removed@new-ui/reset@0.0.3(transitive)
Updated@new-ui/effects@^0.1.3
Updated@new-ui/reset@^0.0.5
Updated@new-ui/spacings@^0.1.3