bufferapp/ui

# ✨ Buffer UI Components ✨

<div align="center">
  <a href="https://www.styled-components.com">
    <img alt="styled-components" src="https://blobscdn.gitbook.com/v0/b/gitbook-28427.appspot.com/o/spaces%2F-LFNym8ScnaWKWBQFWTw%2Favatar.png?generation=1529427935328806&alt=media" height="150px" />
  </a>
</div>

<br />

<div align="center">
  <strong>Buffer's UI components library and Style Guide for the Buffer Platform and the community</strong>
  <br />
  <br />

[![npm package](https://img.shields.io/npm/v/@bufferapp/ui/latest.svg)](https://www.npmjs.com/package/@bufferapp/ui)
[![Build Status](https://travis-ci.org/bufferapp/ui.svg?branch=main)](https://travis-ci.org/bufferapp/ui)
[![Test Coverage](https://api.codeclimate.com/v1/badges/29ea645af66481f4b80b/test_coverage)](https://codeclimate.com/github/bufferapp/ui/test_coverage)

</div>

Welcome to the official Buffer UI library 🎉! This is where we host all the components used by the Buffer applications ([Publish](https://publish.buffer.com), [Analyze](https://analyze.buffer.com) and [Engage](https://engage.buffer.com), as well as our official [Style Documentation](https://bufferapp.github.io/ui)).
This library is open source and free for you to explore and use!

## Installation

Buffer UI  is available as an `@bufferapp/ui` [npm package](https://www.npmjs.com/package/@bufferapp/ui).


## Usage

Here is a quick example to get you started, **it's all you need**:

```jsx
import React from 'react';
import ReactDOM from 'react-dom';
import Button from '@bufferapp/ui/Button';

function App() {
  return (
    <Button type="primary" label="Hello, world!" />
  );
}

ReactDOM.render(<App />, document.querySelector('#app'));
```

For usage instructions and how to add, update, and work with the components, see our [CONTRIBUTING.md](/CONTRIBUTING.md) doc!


## Component Documentation / Reference

Check out our ➡️ [documentation website](https://bufferapp.github.io/ui).


## Contributing

Want to contribute to this project? That's awesome 🙌! Please check out our [contribution](/CONTRIBUTING.md) doc. :)

## Changelog

Curious about the latest changes?
Please read the [changelog](/src/documentation/markdown/GettingStarted/CHANGELOG.md) and check the [latest releases](https://github.com/bufferapp/ui/releases).


## License

This project is licensed under the terms of the
[MIT license](/LICENSE).