Snyk BrandCL 🐾 🖥 💻 📱

Welcome to BrandCL, the official component library for Snyk’s Marketing design system.

Note: This is the successor to the previous prototype, Snyk MarketingUI (aka "SMUi").

Documentation

The full documentation can be found at https://brand-cl.snyk.marketing/.

Getting Started with the Styles Library

Setting it up

Install Snyk BrandCL with either npm:

npm i @snyk-mktg/brand-cl

or yarn:

yarn add @snyk-mktg/brand-cl

Using Snyk BrandCL

Snyk BrandCL is available in both React and Vue versions. The Snyk BrandCL React or Vue Components can then be used within your project by importing them as follows:

import Button from '@snyk-mktg/brand-cl-react/components/atoms/Button';
import Button from '@snyk-mktg/brand-cl-vue/components/atoms/Button';

PLEASE NOTE: The @snyk-mktg/brand-ui Style Library will also need to be included within your project as an additional dependency.