/cerebro-ui

📦 Repository of common UI react components for Cerebro plugins

Primary LanguageTypeScriptMIT LicenseMIT

cerebro-ui

It is UI components library for Cerebro app plugins

Components

This package contains main UI elements that you need to use in your plugin previews:

Keyboard navigation lists

This component used to build lists with keyboard navigation:

  • Arrows and ctrl+j/k used to select next or previous item;
  • enter or o used to select item;
  • ← and esc used to move selection back to main results list;
import { KeyboardNav, KeyboardNavItem } from 'cerebro-ui'

const Preview = ({ items, onSelect }) => (
  <KeyboardNav>
    <ul className={styles.list}>
    {
      items.map(s => (
        <KeyboardNavItem key={s} onSelect={() => onSelect(item)}>
          {item}
        </KeyboardNavItem>
      ))
    }
    </ul>
  </KeyboardNav>
)

Loading

For consistence, it is recommended to use one loading spinner component in all plugins:

import { Loading } from 'cerebro-ui'

const Preview = ({ isLoading }) => (
  isLoading ? <Loading /> : <MyPluginPreview />
)

Form elements

import { Button, Checkbox, Select, Text } from 'cerebro-ui/Form'

Related

  • Cerebro – main repo for Cerebro app;

License

MIT © CerebroApp