Skip to content

Latest commit

 

History

History
221 lines (193 loc) · 18.6 KB

README.md

File metadata and controls

221 lines (193 loc) · 18.6 KB
Raw

Garden React Components Build Status Dependency Status Coverage Status

🌱 Garden is a design system for Zendesk

Garden React provides consistent behavior for Garden components. React components are maintained following a multi-package approach where components are packaged and published individually, but combined under this single repository. Components rely on Garden CSS for styling.

Installation

See the individual package README for the React component you would like to install.

Package Version Dependencies
@zendeskgarden/react-autocomplete npm version Dependency Status
@zendeskgarden/react-avatars npm version Dependency Status
@zendeskgarden/react-breadcrumbs npm version Dependency Status
@zendeskgarden/react-buttons npm version Dependency Status
@zendeskgarden/react-checkboxes npm version Dependency Status
@zendeskgarden/react-chrome npm version Dependency Status
@zendeskgarden/react-grid npm version Dependency Status
@zendeskgarden/react-loaders npm version Dependency Status
@zendeskgarden/react-menus npm version Dependency Status
@zendeskgarden/react-modals npm version Dependency Status
@zendeskgarden/react-notifications npm version Dependency Status
@zendeskgarden/react-pagination npm version Dependency Status
@zendeskgarden/react-radios npm version Dependency Status
@zendeskgarden/react-ranges npm version Dependency Status
@zendeskgarden/react-select npm version Dependency Status
@zendeskgarden/react-selection npm version Dependency Status
@zendeskgarden/react-tabs npm version Dependency Status
@zendeskgarden/react-tables npm version Dependency Status
@zendeskgarden/react-tags npm version Dependency Status
@zendeskgarden/react-testing npm version Dependency Status
@zendeskgarden/react-textfields npm version Dependency Status
@zendeskgarden/react-theming npm version Dependency Status
@zendeskgarden/react-toggles npm version Dependency Status
@zendeskgarden/react-tooltips npm version Dependency Status
@zendeskgarden/react-typography npm version Dependency Status
@zendeskgarden/react-utilities npm version Dependency Status

Usage

Our packages are easily consumable with create-react-app and standard webpack configs. All packages follow a similar installation process. Below is an example of consuming our react-buttons package.

Install dependencies

# Install garden package
npm install @zendeskgarden/react-buttons

# Install peer dependencies
npm install styled-components @zendeskgarden/react-theming

Include global styling and ThemeProvider

import React, { Component } from 'react';
import { render } from 'react-dom';

/** Globally include scoped button styling */
import '@zendeskgarden/react-buttons/dist/styles.css';

/** Include a ThemeProvider at the root of your app */
import { ThemeProvider } from '@zendeskgarden/react-theming';

/** Consume throughout app */
import { Button } from '@zendeskgarden/react-buttons';

class App extends Component {
  render() {
    return (
      <ThemeProvider>
        <Button>Example Garden Button</Button>
      </ThemeProvider>
    );
  }
}

render(<App />, document.getElementById('root'));

Try out Garden React components in a mock product environment.

Edit Garden Create-React-App

Contribution

Thanks for your interest in Garden! Community involvement helps make our design system fresh and tasty for everyone.

Got issues with what you find here? Please feel free to create an issue.

If you'd like to take a crack at making some changes, please follow our contributing documentation for details needed to submit a PR.

Community behavior is benevolently ruled by a code of conduct. Please participate accordingly.

License

Copyright 2019 Zendesk

Licensed under the Apache License, Version 2.0