Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 1.92 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.92 KB

#React UIkit Article

Create articles within your page.

See http://otissv.github.io/react-uikit-components/ for docs.

##Usage The master branch has been updated to React 15. To use with React 0.14 checkout 0.14 branch.

UIkit css is not included. You can get it from getuikit.com

###Installation

npm install react-uikit-article --save;

// ES6
import Article from 'react-uikit-article';

// ES5
var Article = require('react-uikit-article').default;

Example

<Article
  title='Article title'
  meta='Written by Super User on 12 April 2012. Posted in Blog'
  lead='Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
    eiusmod tempor incididunt ut labore et dolore magna aliqua.' >

  <p>
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
    quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  </p>

  <hr className="uk-article-divider" />

  <p>
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
    tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
    quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
  </p>
  <a href="#">Read more</a>
</Article>

##Tests

npm run testto run tests with minimal output.
npm run test:spec to run tests with detailed output.
npm run test:watch watches all directories and run tests with minimal output on file changes.

##Build npm run build to build files fro distribution.
npm run build:watch watches src directory and builds files on changes.

##Lint npm run lint lints scripts in src directory.
npm run lint:watch watches src directory and lints scripts in src directory.

##License MIT