npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prompt-ui

v0.1.6

Published

Terminal UI library

Downloads

16

Readme

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

| name | description | default | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | | commands | List of commands to be provided as a key value pair where value can be either a string, JSX/HTML tag or callback | null | | errorMessage | Message to show when unidentified command executed, can be either a string, JSX/HTML tag or callback | "not found!" | | settings | Prompt settings defining the appearance and behavior of the Prompt. This includes properties such as the prompt displayed at the beginning of input and the theme applied to the PromptShell interface. See Default Settings for default values and configurations. | null |

Settings

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

Theme

interface Theme {
  // TODO
}

In-built commands

| command | description | | ------- | --------------------------------------- | | clear | clears the console | | history | show last {property.historySize} inputs |

Report a bug

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