prompt-ui v0.1.6

prompt-ui

Features

TODO

Installation

Install package with NPM or YARN and add it to your development dependencies:

npm install prompt-ui

OR

yarn add prompt-ui

Usage

import { PromptShell } from "prompt-ui";

function App(props) {
  // Define commands here
  const commands = {
    TODO
  };

  return (
    <PromptShell
      commands={commands}
    />
  );
}

Also make sure to wrap the main mount point around the PromptContextProvider. This retains the state even when the component is unmounted and then mounted back:

import { PromptContextProvider } from "prompt-ui";

ReactDOM.render(
  <PromptContextProvider>
    <App/>
  </PromptContextProvider>,
  rootElement
);

Add an HTML element to the page

Create an HTML page, or edit an existing one, and add the following within the body tags:

    <prompt TODO></prompt>
    <script src="https://unpkg.com/prompt-ui> </script>

Open the HTML file in your browser, and your prompt interface will be displayed on page.

Creating custom themes

The component comes with few in-built themes: light, dark. You can also create custom themes by passing themes parameter in props, as follows:

<PromptShell
  commands={commands}
  settings={settings}
/>

Props

Settings

interface Settings {
  prompt: "$";
  theme: Theme;
  // TODO
}

Theme

interface Theme {
  // TODO
}

In-built commands

Report a bug

If you found a bug in this library, please file an GitHub issue here.