npm.io
1.0.101 • Published 3 years ago

@foundationui/smart-input

Licence
MIT
Version
1.0.101
Deps
3
Size
576 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

<SmartInput>

Drop-in <input> and <textarea> replacement that that provides inline, tab-completable suggestions like GitHub Copilot and Gmail Smart Compose for any app.

demo user composing an email with SmartInput

The component learns from user input and makes better suggestions over time.

import { SmartInput } from '@foundationui/smart-input'

function MySmartInput() {
  const [value, setValue] = useState('')
  return (
    <SmartInput
      placeholder="Type something..."
      renderText={props => <span {...props} />}
      renderCompletion={props => <span style={{ opacity: 0.4 }} {...props} />}
      value={value}
      onChange={setValue}
      multiline={false}
    />
  )
}

Examples:


Install

npm

npm install --save @foundationui/smart-input
yarn
yarn add @foundationui/smart-input

How it works

<SmartInput> completes the text you write just like GitHub Copilot. It's not very smart at first, but it quickly learns to be useful. Start by creating a model on foundation-ui.com then set the model property:

<SmartInput model="foundation/hn-comment" />

As you enter keystrokes into <SmartInput>, at first it won't do anything at all but learn. Once it's confident enough, it'll start suggesting completions. You can control how confident you want <SmartInput> to be, which users should get completions, and other settings from your admin console on foundation-ui.com.


Learning user style & preferences

Not all users write the same way, and not all users want completions! Not yet. <SmartInput> learns how to be most helpful to each user if you set the user property:

<SmartInput user="a unique, stable identifier from your app" />

Providing context

To generate the best completions, give <SmartInput> whatever extra context you think would be useful. Provide data as a string:

<SmartInput
  context={JSON.stringify({
    subject: 'This is too easy to integrate',
    recipient: 'jane@doe.com',
  })}
/>

Don't need to worry about how you format the string, but it's useful to be descriptive. You an use an English sentence, a JSON.stringify'd object of key/value pairs, both, etc.


Bootstrap data

<SmartInput> can start learning without any data. If you want to accelerate the process, you can upload a list of strings to foundation-ui.com to bootstrap the model.

You can also send your data to our data ingestion endpoint, which accepts inputs your users have already written.

curl -X POST https://api.foundation-ui.com/v0/database \
  -H 'Content-Type: application/json' \
  -H 'X-Api-Key: <your api key>' \
  -d @- <<BODY
{
  "repository": "my-org/support-widget",
  "table": "Table1",
  "data": [{
    "user": "elonmusk",
    "context": "Subject: 'This is too easy to integrate'\nTo: 'support@foundation-ui.com'",
    "input": "Hey, SmartInput is awesome! It only took me a couple of minutes to",
    "output": " add it to my application."
  }]
}
BODY

In the example above, the id, user, context, and completion, fields are all optional.


Deploy to prod

<SmartInput> is designed for your peace of mind. In addition to the controls provided for your model on foundation-ui.com, you can set the component's safeMode property to prevent showing completions:

<SmartInput safeMode />

While in safe mode, <SmartInput> will still learn from user keystrokes, but will not show any completions to users.

Therefore we recommend as the safest path to production:

  1. (optional) Bootstrap your model with data on foundation-ui.com
  2. Replace one of the inputs in your app with <SmartInput safeMode />
  3. Tune settings and review model performance on foundation-ui.com until you are satisfied with the results

Coming soon

Soon on foundation-ui.com, you'll be able to ...

  • deploy a model to a small fraction of your users
  • check how often they accepted completions
  • A/B test different model versions
  • build confidence over time

Improve your model

Once your models are live, you can play with them to make them smarter. First, take a look at your models' accepted completion rate to see how useful it is to your users.

Next, improve your model by creating different versions of your model (branches), train them with different sets of data, request completions with different parameters, A/B test branches, etc.

Props

model: string | undefined

The identifier of your model, in the form {model-owner}/{model-slug}. Can be shared across different inputs, or unique per input. If you don't specify one, it will show an example completion without querying a model.

user: string | undefined

An stable identifier of the user using the input. Providing this helps the model learn a particular user's style, including if they prefer not to use completions at all.

context: string | undefined

Data that will help the model generate better completions. Pass anything that you think is relevant to making the completions better or more personalized.

For example, it could be an English sentence description of what's happening in your app or a JSON.stringify'd object of useful key/value pairs.

value: string

The controlled value of the input.

onChange: (newValue: string) => void

Invoked whenever the text value of the content changes. Use this to update the controlled value.

renderText: (props: any) => React.ReactElement

Invoked to display normal text, returns a React element. You should use an inline display element (e.g. span) and spread props, like so:

renderText={props => <span {...props} />}

You may add whatever styling you like like via style, className, etc.

renderCompletion: (props: any) => React.ReactElement

Invoked to display completion text, returns a React element. You should use an inline display element (e.g. span) and spread props, like so:

renderCompletion={props => <span {...props} />}

You may add whatever styling you like like via style, className, etc.

renderPlaceholder: ((props: any) => React.ReactElement) | undefined

Invoked to display placeholder text, returns a React element. You should use an inline display element (e.g. span) and spread props, like so:

renderCompletion={props => <span {...props} />}

You may add whatever styling you like like via style, className, etc.

WARNING: if you want to set style, make sure to merge the style from props like so:

renderCompletion={props => <span {...props} style={{...props.style, color: 'red' }} />}
placeholder: string | undefined

The text to display when value is empty. If not provided, no placeholder is displayed.

multiline: boolean | undefined

Whether or not to allow multiline text. Default false.

onShowCompletion: ((completion: string) => void) | undefined

Called when a non-empty completion is shown to the user.

onAcceptCompletion: ((completion: string) => void) | undefined

Called when a non-empty completion is accepted by the user.

onBlur: React.FocusEventHandler<HTMLElement> | undefined

Standard onBlur handler, analogous to the one from <input> and <textarea> elements.

onFocus: React.FocusEventHandler<HTMLElement> | undefined

Standard onFocus handler, analogous to the one from <input> and <textarea> elements.

onKeyDown: React.KeyboardEventHandler<HTMLElement> | undefined

Standard onKeyDown handler, analogous to the one from <input> and <textarea> elements. Note that this handler is called after any keyboard events captured by <SmartInput> (e.g. Tab to accept a suggestion).

disabled: boolean | undefined

Whether the input is editable. If true, the input is read-only.

safeMode: boolean | undefined

Whether to run in safe mode. In safe mode, no completions will be shown, but your input will still collect data to learn to generate completions. You can see the completions that would have been shown to your users on foundation-ui.com

container: React.ElementType<P> | undefined

Element to use as the wrapper component. If not provided, the component will render as a <div> with contenteditable="true".

containerProps: P | undefined

Props that will get passed to the container element, when one is provided.