@blueconduit/copper
v2.1.0
Published
BlueConduit's design system
Downloads
14
Readme
copper
Copper's styles are defined in the scss/
directory.
The root file is scss/copper.scss
. It essentially imports all the styles into one place, and is the file that Gulp compiles from Sass into a CSS file.
Installing in another project
npm install @blueconduit/copper
Folder structure
Our styles follow the ITCSS structure. More to come here in the future, but this is the spark notes explanation.
- 01_settings: Contains fundamental values, called Design Tokens, that are reused throughout the styles. These are things like colors, typefaces, spacing values, etc.
- 02_tools: A place for Sass mixins and functions, think reusable scripts we can call to create our styles with
- 03_normalize: Simply a place to add our Normalizing CSS styles, and the first actual styling rules appear here.
- 04_elements: Styling for entire elements. Typography rules are what's here right now.
- 05_objects: Classes built to help layout the UIs we make with Copper.
- 06_components: Styles specifically intended for Copper components
- 07_overrides: Classes that should take precedence over others, will probably be mostly spacing and positioning classes
Build process
We use Gulp.js to compile our Sass styles into CSS. To run the Gulp build process:
pnpm build
There is a watch command to watch Sass files for changes and recompile:
pnpm build:watch
This will compile the Sass into css/copper.css
, and it will also minify that new file and save it at css/copper.min.css
.
Either CSS file can be used to get Copper's styles into your project.
Publishing new package version
See the root level README for details on publishing new versions of this package.