2.0.3 ⢠Published 5 years ago
react-terminal-command v2.0.3
React Terminal Command
A customizable terminal command viewer in React. š
Install
Using yarn
yarn add react-terminal-commandUsing npm
npm install react-terminal-commandBasic Usage
import React from 'react'
import ReactTerminalCommand from 'react-terminal-command'
const Example = () => {
return <ReactTerminalCommand command='yarn install react-terminal-command' />
}Advanced Usage
import React from 'react'
import ReactTerminalCommand from 'react-terminal-command'
const Example = () => {
return (
<ReactTerminalCommand
command='yarn install react-terminal-command'
color='#d40188'
withDark
/>
)
}Additional Info
- React Terminal Command is container-width-preffered. Use container width based on your application preference.
colorprop supports both 6 digit and 3 digit hex codes. If your props has an issue default red will be used and console will display an error below.
āļø Invalid hex color code provided. Default will be used.Features
- Switchable dark mode and light mode
- Command copy option
- Container preffered width
- Several command colors to choose from
Props
| Name | Type | Description |
|---|---|---|
| command | String | Required. The command to display. |
| withDark | boolean | Enable/Disable dark mode. Default: false |
| color | String | Primary color for terminal command. Default: #ff0000 |
Contribute
- Submit an issue
- Fork the repository
- Create a dedicated branch (never ever work in master)
- The first time, run command:
yarnornpm installinto the directory - Run
yarn run buildornpm run build - Link lib locally with
yarn linkornpm link - Fix bugs or implement features
- Always write tests
Run Library
Using yarn
yarn startusing npm
npm startApplication build will be triggered in watch moode.
Run Tests
Using yarn
yarn test:watchUsing npm
npm test:watchLicense
MIT Ā© dhanushkac
Related Projects
Angular Terminal Command - coming soon
Vue Terminal Command - coming soon