{"id":13755424,"url":"https://github.com/trendmicro-frontend/react-buttons","last_synced_at":"2025-09-04T14:32:29.539Z","repository":{"id":57167640,"uuid":"76014058","full_name":"trendmicro-frontend/react-buttons","owner":"trendmicro-frontend","description":"React Buttons component","archived":false,"fork":false,"pushed_at":"2023-09-22T14:08:05.000Z","size":3376,"stargazers_count":12,"open_issues_count":1,"forks_count":6,"subscribers_count":19,"default_branch":"master","last_synced_at":"2024-12-12T09:59:38.989Z","etag":null,"topics":["button","button-group","button-toolbar","buttons","react"],"latest_commit_sha":null,"homepage":"https://trendmicro-frontend.github.io/react-buttons","language":"Stylus","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trendmicro-frontend.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-12-09T07:51:37.000Z","updated_at":"2023-09-22T14:08:00.000Z","dependencies_parsed_at":"2024-01-17T15:04:32.376Z","dependency_job_id":"e361086c-d1b4-4e05-89aa-4c4afa8d6e3f","html_url":"https://github.com/trendmicro-frontend/react-buttons","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trendmicro-frontend%2Freact-buttons","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trendmicro-frontend%2Freact-buttons/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trendmicro-frontend%2Freact-buttons/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trendmicro-frontend%2Freact-buttons/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trendmicro-frontend","download_url":"https://codeload.github.com/trendmicro-frontend/react-buttons/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231970066,"owners_count":18453907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["button","button-group","button-toolbar","buttons","react"],"created_at":"2024-08-03T10:00:54.056Z","updated_at":"2024-12-31T09:32:45.954Z","avatar_url":"https://github.com/trendmicro-frontend.png","language":"Stylus","funding_links":[],"categories":["Trend Micro"],"sub_categories":["React Components"],"readme":"# react-buttons [![build status](https://travis-ci.org/trendmicro-frontend/react-buttons.svg?branch=master)](https://travis-ci.org/trendmicro-frontend/react-buttons) [![Coverage Status](https://coveralls.io/repos/github/trendmicro-frontend/react-buttons/badge.svg?branch=master)](https://coveralls.io/github/trendmicro-frontend/react-buttons?branch=master)\n\n[![NPM](https://nodei.co/npm/@trendmicro/react-buttons.png?downloads=true\u0026stars=true)](https://nodei.co/npm/@trendmicro/react-buttons/)\n\nReact Buttons component.\n\nDemo: https://trendmicro-frontend.github.io/react-buttons\n\n## Installation\n\n1. Install the latest version of [react](https://github.com/facebook/react) and [react-buttons](https://github.com/trendmicro-frontend/react-buttons):\n\n  ```\n  npm install --save react @trendmicro/react-buttons\n  ```\n\n2. At this point you can import `@trendmicro/react-buttons` and its styles in your application as follows:\n\n  ```js\n  import { Button, ButtonGroup, ButtonToolbar } from '@trendmicro/react-buttons';\n\n  // Be sure to include styles at some point, probably during your bootstraping\n  import '@trendmicro/react-buttons/dist/react-buttons.css';\n  ```\n\n## Recommended Setup\n\nCreate a `Buttons` component inside your common components directory:\n```\ncomponents/\n  Buttons/\n    index.js\n```\n\n**components/Buttons/index.js**\n```js\nimport '@trendmicro/react-buttons/dist/react-buttons.css';\n\nexport { Button, ButtonGroup, ButtonToolbar } from '@trendmicro/react-buttons';\n```\n\nThen, import `Button` component in your code:\n```js\nimport { Button } from './components/Buttons';\n```\n\n## Usage\n\n### Button Styles\n\n```js\n\u003cButton btnStyle=\"default\"\u003eDefault\u003c/Button\u003e\n\u003cButton btnStyle=\"primary\"\u003ePrimary\u003c/Button\u003e\n\u003cButton btnStyle=\"emphasis\"\u003eEmphasis\u003c/Button\u003e\n\u003cButton btnStyle=\"danger\"\u003eDanger (Alias of Emphasis)\u003c/Button\u003e\n\u003cButton btnStyle=\"flat\"\u003eFlat\u003c/Button\u003e\n\u003cButton btnStyle=\"border\"\u003eBorder (Alias of Flat)\u003c/Button\u003e\n\u003cButton btnStyle=\"link\"\u003eLink\u003c/Button\u003e\n```\n\n### Button Sizes\n\n```js\n\u003cButton btnSize=\"lg\"\u003eLarge\u003c/Button\u003e\n\u003cButton btnSize=\"large\"\u003eLarge\u003c/Button\u003e\n\u003cButton btnSize=\"md\"\u003eMedium\u003c/Button\u003e\n\u003cButton btnSize=\"medium\"\u003eMedium\u003c/Button\u003e\n\u003cButton btnSize=\"sm\"\u003eSmall\u003c/Button\u003e\n\u003cButton btnSize=\"small\"\u003eSmall\u003c/Button\u003e\n\u003cButton btnSize=\"xs\"\u003eExtra Small\u003c/Button\u003e\n\u003cButton btnSize=\"extra-small\"\u003eExtra Small\u003c/Button\u003e\n```\n\n### Button States\n\n```js\n\u003cButton\u003eNormal\u003c/Button\u003e\n\u003cButton hover\u003eHover\u003c/Button\u003e\n\u003cButton active\u003eActive\u003c/Button\u003e\n\u003cButton focus\u003eFocus\u003c/Button\u003e\n\u003cButton disabled\u003eDisabled\u003c/Button\u003e\n```\n\n### Block Buttons (Full-width Buttons)\n\n```js\n\u003cButton block\u003eBlock Button\u003c/Button\u003e\n```\n\n### Button Groups\n\n#### Default button group\n\n```js\n\u003cButtonGroup\u003e\n    \u003cButton active\u003eLeft\u003c/Button\u003e\n    \u003cButton\u003eMiddle\u003c/Button\u003e\n    \u003cButton\u003eRight\u003c/Button\u003e\n\u003c/ButtonGroup\u003e\n\u003cButtonGroup\u003e\n    \u003cButton compact\u003e\u003ci className=\"fa fa-pencil\" /\u003e\u003c/Button\u003e\n    \u003cButton compact\u003e\u003ci className=\"fa fa-mail-reply\" /\u003e\u003c/Button\u003e\n\u003c/ButtonGroup\u003e\n```\n\n#### Flat button group\n\n```js\n\u003cButtonGroup btnStyle=\"flat\" btnSize=\"md\"\u003e\n    \u003cButton active\u003eLeft\u003c/Button\u003e\n    \u003cButton\u003eMiddle\u003c/Button\u003e\n    \u003cButton\u003eRight\u003c/Button\u003e\n\u003c/ButtonGroup\u003e\n\u003cButtonGroup btnStyle=\"flat\" btnSize=\"md\"\u003e\n    \u003cButton compact\u003e\u003ci className=\"fa fa-pie-chart\" /\u003e\u003c/Button\u003e\n    \u003cButton compact\u003e\u003ci className=\"fa fa-line-chart\" /\u003e\u003c/Button\u003e\n    \u003cButton compact\u003e\u003ci className=\"fa fa-table\" /\u003e\u003c/Button\u003e\n\u003c/ButtonGroup\u003e\n```\n\n#### Vertical button group\n\n```js\n\u003cButtonGroup vertical\u003e\n    \u003cButton\u003eTop\u003c/Button\u003e\n    \u003cButton\u003eMiddle\u003c/Button\u003e\n    \u003cButton\u003eBottom\u003c/Button\u003e\n\u003c/ButtonGroup\u003e\n```\n\n### Button Toolbar\n\n```js\n\u003cButtonToolbar\u003e\n    \u003cButtonGroup\u003e\n        \u003cButton\u003eButton Group 1\u003c/Button\u003e\n        \u003cButton\u003eButton Group 1\u003c/Button\u003e\n    \u003c/ButtonGroup\u003e\n    \u003cButtonGroup\u003e\n        \u003cButton\u003eButton Group 2\u003c/Button\u003e\n        \u003cButton\u003eButton Group 2\u003c/Button\u003e\n    \u003c/ButtonGroup\u003e\n\u003c/ButtonToolbar\u003e\n```\n\n### Button (w/ Icon)\n\n#### Static (default)\n\n```js\n\u003cButton\u003e\n    \u003ci className=\"fa fa-download\" /\u003e\n    Download\n\u003c/Button\u003e\n\u003cButton btnStyle=\"primary\"\u003e\n    \u003ci className=\"fa fa-plus\" /\u003e\n    Add Account\n\u003c/Button\u003e\n```\n\n### Progressing\n\n```js\n\u003cButton disabled\u003e\n    \u003ci className=\"fa fa-circle-o-notch fa-spin\" /\u003e\n    Uploading\n\u003c/Button\u003e\n\u003cButton btnStyle=\"primary\" disabled\u003e\n    \u003ci className=\"fa fa-circle-o-notch fa-spin\" /\u003e\n    Uploading\n\u003c/Button\u003e\n```\n\n#### Static (flat)\n\n```js\n\u003cButton btnStyle=\"flat\"\u003e\n    \u003ci className=\"fa fa-pencil fa-fw\" /\u003e\n    Edit\n\u003c/Button\u003e\n\u003cButton btnStyle=\"flat\"\u003e\n    \u003ci className=\"fa fa-trash-o fa-fw\" /\u003e\n    Delete\n\u003c/Button btnStyle=\"flat\"\u003e\n\u003cButton\u003e\n    \u003ci className=\"fa fa-book fa-fw\" /\u003e\n    Library\n\u003c/Button\u003e\n```\n\n#### Compact\n\n```js\n\u003cButton compact\u003e\n    \u003ci className=\"fa fa-comment\" /\u003e\n\u003c/Button\u003e\n\u003cButton btnStyle=\"primary\" compact\u003e\n    \u003ci className=\"fa fa-plus\" /\u003e\n\u003c/Button\u003e\n\u003cButton btnStyle=\"emphasis\" compact\u003e\n    \u003ci className=\"fa fa-search\" /\u003e\n\u003c/Button\u003e\n\u003cButton btnStyle=\"flat\" compact\u003e\n    \u003ci className=\"fa fa-cog\" /\u003e\n\u003c/Button\u003e\n```\n\n## API\n\n### Properties\n\n#### Button\n\nName | Type | Default | Description \n:--- | :--- | :------ | :----------\ncomponentClass | Function or String | 'button' |\ntype | One of:\u003cbr/\u003e'button'\u003cbr/\u003e'reset'\u003cbr/\u003e'submit' | 'button' |\nbtnSize | One of:\u003cbr/\u003e'lg'\u003cbr/\u003e'md'\u003cbr/\u003e'sm'\u003cbr/\u003e'xs'\u003cbr/\u003e'large'\u003cbr/\u003e'medium'\u003cbr/\u003e'small'\u003cbr/\u003e'extra-small' | 'md' |\nbtnStyle | One of:\u003cbr/\u003e'default'\u003cbr/\u003e'primary'\u003cbr/\u003e'danger'\u003cbr/\u003e'emphasis'\u003cbr/\u003e'border'\u003cbr/\u003e'flat'\u003cbr/\u003e'link'\u003cbr/\u003e | 'default' |\nactive | Boolean | false |\nhover | Boolean | false |\nfocus | Boolean | flase |\ndisabled | Boolean | flase |\nblock | Boolean | false |\ncompact | Boolean | false |\n\n#### ButtonGroup\n\nName | Type | Default | Description \n:--- | :--- | :------ | :----------\nbtnSize | One of:\u003cbr/\u003e'lg'\u003cbr/\u003e'md'\u003cbr/\u003e'sm'\u003cbr/\u003e'xs'\u003cbr/\u003e'large'\u003cbr/\u003e'medium'\u003cbr/\u003e'small'\u003cbr/\u003e'extra-small' | |\nbtnStyle | One of:\u003cbr/\u003e'default'\u003cbr/\u003e'primary'\u003cbr/\u003e'danger'\u003cbr/\u003e'emphasis'\u003cbr/\u003e'border'\u003cbr/\u003e'flat'\u003cbr/\u003e'link'\u003cbr/\u003e | |\nvertical | Boolean | false |\n\n#### ButtonToolbar\n\nName | Type | Default | Description \n:--- | :--- | :------ | :----------\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrendmicro-frontend%2Freact-buttons","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrendmicro-frontend%2Freact-buttons","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrendmicro-frontend%2Freact-buttons/lists"}