ens-usernames/app/ui/components/Button/README.md

1.4 KiB

Button

A simple Button component.

Usage

import { Button } from '@aragon/ui'

const App = () => (
  <Button>Hello World</Button>
)

Properties

mode

  • Type: String
  • Values: normal (default), secondary, outline, strong or text.

Set this property to the desired visual variant.

Example:

const App = () => (
  <div>
    <Button mode="outline">Cancel</Button>
    <Button mode="strong">Accept</Button>
  </div>
)

emphasis

  • Type: String
  • Values: positive or negative.

Set this property to provide positive or negative visual cues.

Example:

const App = () => (
  <div>
    <Button emphasis="negative">Cancel</Button>
    <Button emphasis="positive">Accept</Button>
  </div>
)

compact

  • Type: Boolean
  • Default: false

Set to true to obtain a button that contains less padding than normal buttons.

Example:

const MyButton = () => (
  <Button compact>Accept</Button>
)

wide

  • Type: Boolean
  • Default: false

Set to true to obtain a button that expands horizontally.

Example:

const MyButton = () => (
  <Button wide>Accept</Button>
)

Attached Components

Anchor

An <a> styled to be visually similar to Buttons, supporting the same properties.

Example:

const LinkButton = () => (
  <Button.Anchor mode="strong" href="https://aragon.one/" target="_blank">
    Aragon
  </Button.Anchor>
)