0.0.3 • Published 7 years ago

@inthepocket/itp-rcc-card v0.0.3

Weekly downloads
3
License
MIT
Repository
-
Last release
7 years ago

ITP Card component

Usage

$ npm install @inthepocket/itp-rcc-card

Import (Typescript)

import { default as Card } from '@inthepocket/itp-rcc-card';

Import (ES)

import Card from '@inthepocket/itp-rcc-card/dist/Card';

JSX

<Card size="default">
  <Card.Header>
    <h1>Card Header</h1>
  </Card.Header>
  <Card.Body>
    <h2>Card Body title</h2>
    <p>Card Body content</p>
  </Card.Body>
  <Card.Footer>
    <p>Card footer</p>
  </Card.Footer>
</Card>

Card.Header & Card.Footer are optional.

API documentation

Card

<Card size="default"></Card>
PropertyDescriptionTypeDefaultRequired
hrefLink urlstring-No
prefixCssPrefix for css classNamesstring'card'No
sizedefault, small or largestring'default'No
stylesimported css module (if passed, prefixed classNames will be disabled), see styles propertyobjectnullNo
typeprimary, secondary or tertiarystring'primary'No
onClickFunction-No
targetLink targetstring-No

Styles property

PropertyDescriptionTypeDefaultRequired
bodystring-Yes
bodySizeLargestring-No
bodySizeSmallstring-No
cardstring-Yes
footerstring-No
footerSizeLargestring-No
footerSizeSmallstring-No
headerstring-No
headerSizeLargestring-No
headerSizeSmallstring-No
linkstring-No
typePrimarystring-No
typeSecondarystring-No
typeTertiarystring-No

The css module should look like this:

.card             { ... }
.header           { ... }
.headerSizeSmall  { ... }
.headerSizeLarge  { ... }
.body             { ... }
.bodySizeSmall    { ... }
.bodySizeLarge    { ... }
.footer           { ... }
.footerSizeSmall  { ... }
.footerSizeLarge  { ... }
.link             { ... }
.typePrimary      { ... }
.typeSecondary    { ... }
.typeTertiary     { ... }

Body

<Card size="default">
  <Card.Body>
    ...
  </Card.Body>
</Card>

Header

<Card size="default">
  <Card.Header>
    ...
  </Card.Header>
</Card>

Footer

<Card size="default">
  <Card.Footer>
    ...
  </Card.Footer>
</Card>

Development

Installation

$ npm install

Test

$ npm run test

Build

Compiles the TypeScript source to ES5.

$ npm run build