react-terminal-command
v2.0.3
Published
A terminal command viewer in React
Downloads
26
Readme
React Terminal Command
A customizable terminal command viewer in React. 🚀
Install
Using yarn
yarn add react-terminal-command
Using npm
npm install react-terminal-command
Basic 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.
color
prop 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:
yarn
ornpm install
into the directory - Run
yarn run build
ornpm run build
- Link lib locally with
yarn link
ornpm link
- Fix bugs or implement features
- Always write tests
Run Library
Using yarn
yarn start
using npm
npm start
Application build will be triggered in watch moode.
Run Tests
Using yarn
yarn test:watch
Using npm
npm test:watch
License
MIT © dhanushkac
Related Projects
Angular Terminal Command - coming soon
Vue Terminal Command - coming soon