Code Monkey home page Code Monkey logo

react-terminal-command's Introduction

A customizable terminal command viewer in React. ๐Ÿš€

NPM JavaScript Style Guide Node.js CI

React terminal command

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

  1. Submit an issue
  2. Fork the repository
  3. Create a dedicated branch (never ever work in master)
  4. The first time, run command: yarn or npm install into the directory
  5. Run yarn run build or npm run build
  6. Link lib locally with yarn link or npm link
  7. Fix bugs or implement features
  8. 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

react-terminal-command's People

Contributors

dhanushkac avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

racl31

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.