npm.io
1.1.9 • Published 4 years ago

@coopdigital/blockquote

Licence
MIT
Version
1.1.9
Deps
0
Size
8 kB
Vulns
0
Weekly
0

Component Blockquote

This repository is a template for creating new components for the Co-op design system.


component-blockquote

Your brief description of your component.

Installation

Install via npm:

$ npm install @coopdigital/component-blockquote --save

Usage

React

You can include this react component in your project by importing importing it via the import statement.

import Blockquote from '@coopdigital/blockquote';

If you want to use the JSX template for compiling in your own project you can include the component with the following import statement

import Blockquote from 'node_modules/@coopdigital/component-blockquote/src/Blockquote.jsx'
Component Props

The blockquote has the following props you need to populate content or use a variant

Prop name Prop type Requried
quote string YES
citation string YES
quoteLarge boolean NO
CSS

You can include component-blockquote css in your project by referencing it from your existing CSS via @import statement:

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

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

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

If you use a postcss-import plugin:

@import "@coopdigital/component-blockquote";

License

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

Keywords