@coopdigital/component-signpost

Component signpost

Card component used on colleagues.coop.co.uk and coop.co.uk/recipes

Installation

Install via npm or Yarn:

$ npm install @coopdigital/component-signpost --save
# OR
$ yarn add @coopdigital/component-signpost

Usage

You can include component-signpost in your project by referencing it from your existing CSS via @import statement, i.e.:

@import "node_modules/@coopdigital/component-signpost/dist/signpost.css";

If you use PostCSS in your build pipeline, you can reference the sources directly like so:

@import "node_modules/@coopdigital/component-signpost/src/signpost.pcss";

If you use a postcss-import plugin, it gets even easier:

@import "@coopdigital/component-signpost";

Examples

Here's a bunch of examples, showing how you can integrate this CSS module in your project, based on most popular stacks of project. You can either use a post-processed and pre-built CSS form the dist directory, ot use PostCSS sources from the src dir.

The latter have certain dependencies, which should be consumed by your frontend toolkit to postprocess the CSS correctly.

Vue.js

TBD

React.js

TBD

Development

TBD

License

Copyright (c) 2021 Co-operative Group Limited. Licensed MIT.