dotfoods-style
v1.0.12
Published
Dot Foods Brand Colors and Pattern Library
Downloads
5
Readme
Dot Foods Brand Colors and Style Guide
The Dot Foods Style package is designed to be shared across teams to ensure the proper use of branding colors for all Dot Foods digital properties.
Installation & Setup
Install node package
npm i dotfoods-styleHow to use
Import partials into your project files
At the most basic level, simply import the colors.scss (or colors.less) file into your Vue, React, or Angular components for those color variables to be accessible in your project.
@import '../../node_modules/dotfoods-style/scss/colors';
// or
@import '../../node_modules/dotfoods-style/less/colors';It is also possible to import branding colors as a JavaScript object from colors.js.
import colors from '../../node_modules/dotfoods-style/js/colors';CSS Custom Properties
colors.css is an alternate approach that leverages a collection of CSS custom properties to inform all SCSS variables, Less variables, and JS objects for use in your project. This file can be overwritten or replaced if alternative themeing is necessary without having to update the variables used througout the code in your project.
In addition to being able to re-theme your application, another benefit to using CSS custom properties is having the ability to change variable value in code, which is something that cannot be done using SCSS or Less variables.
JS Example:
// Set property value
document.documentElement.setProperty('--color-brand-primary', '#0082ca');
// Get property value
document.documentElement.getPropertyValue('--color-brand-primary');To implement this approach, simply copy the colors.css file from the node_modules folder to the output directory using any front-end build process.
Webpack Example:
const webpack = require("webpack")
const path = require('path');
const CopyPlugin = require('copy-webpack-plugin');
module.exports = {
mode: "development",
plugins: [
new CopyPlugin([
{
from: path.resolve(__dirname, '../../node_modules/dotfoods-style/css/colors.css'),
to: path.resolve('./css/colors.css')
}
]),
],
};Then link to the css file in your index.html or layout template.
<!-- HTML -->
<head>
...
<link href="/css/colors.css" rel="stylesheet" type="text/css">
</head>Linking to colors.css adds CSS custom properties and values to the root element
/* CSS Custom Properties */
:root {
--color-brand-primary: #0082ca;
--color-brand-primary-light: #1b7fcc;
--color-brand-primary-dark: #0065a4;
--color-brand-accent: #faba11;
--color-brand-accent-dark: #eaaa00;
...
}CSS custom properties are referenced by their coresponding SCSS/Less variables
/* SCSS Variables */
$brand-primary: var(--color-brand-primary);
$brand-primary-light: var(--color-brand-primary-light);
$brand-primary-dark: var(--color-brand-primary-dark);
$brand-accent: var(--color-brand-accent);
$brand-accent-dark: var(--color-brand-accent-dark);
.../* Less Variables */
@brand-primary: var(--color-brand-primary);
@brand-primary-light: var(--color-brand-primary-light);
@brand-primary-dark: var(--color-brand-primary-dark);
@brand-accent: var(--color-brand-accent);
@brand-accent-dark: var(--color-brand-accent-dark);
...CSS Custom Properties can also be accessed by the colors JavaScript object in code
// JavaScript Object
const styles = getComputedStyle(document.documentElement);
const colors = {
/* Brand Primary Variables */
brandPrimary: styles.getPropertyValue('--color-brand-primary'),
brandPrimaryLight: styles.getPropertyValue('--color-brand-primary-light'),
brandPrimaryDark: styles.getPropertyValue('--color-brand-primary-dark)'),
brandAccent: styles.getPropertyValue('--color-brand-accent'),
brandAccentDark: styles.getPropertyValue('--color-brand-accent-dark')
...
}Import CSS Custom Properties partials into your project files
@import '../../node_modules/dotfoods-style/scss/css-colors';
// or
@import '../../node_modules/dotfoods-style/less/css-colors';Access CSS Custom Properties color values from the JavaScript object
import colors from '../../node_modules/dotfoods-style/js/css-colors';