Airship
Airship is a components library built by CARTO
⚠️ WARNING ⚠️
This library is in ALPHA stage.
Breaking changes are expected.
Installation
Airship is available as an npm package.
# Using NPM
npm install --save @carto/airship
# Using Yarn
yarn add @carto/airship
React, ReactDOM, PropTypes and styled-components are peer dependencies, if you haven't already installed them you can use:
# Using NPM
npm install --save react react-dom prop-types styled-components
# Using Yarn
yarn add react react-dom prop-types styled-components
Usage
Import components from Airship:
//ES6 import syntax
import { Button } from '@carto/airship';
//CommonJS require syntax
const { Button } = require('@carto/airship');Airship components are used just like any other React component. You can also customise them with props:
// Primary button
<Button>Hello there</Button>
// Secondary button
<Button secondary>General Kenobi</Button>For a more detailed usage guide check out our documentation.
Contributing
Everyone is welcome to contribute. Please take a moment to read the contributing guidelines.
License
BSD-3-Clause, see the included LICENSE.md file.