Gathering detailed insights and metrics for @foundationui/smart-input
Gathering detailed insights and metrics for @foundationui/smart-input
Installations
npm install @foundationui/smart-inputDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
18.14.0
NPM Version
9.3.1
Releases
Unable to fetch releases
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
Maintainers
2
Package Meta Information
Latest Version
1.0.101
Package Id
@foundationui/smart-input@1.0.101
Unpacked Size
575.98 kB
Size
163.97 kB
File Count
41
NPM Version
9.3.1
Node Version
18.14.0
Published on
Feb 23, 2023
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
3
Dev Dependencies
29
@chakra-ui/react@emotion/react@emotion/styled@rollup/plugin-babel@rollup/plugin-commonjs@rollup/plugin-node-resolve@rollup/plugin-replace@rollup/plugin-terser@rollup/plugin-typescript@testing-library/jest-dom@testing-library/react@testing-library/user-event@types/node@types/react@types/react-dom@types/styled-componentsbabel-plugin-styled-componentsformikframer-motionnextprettierreactreact-domresize-observer-polyfillrolluprollup-plugin-dtsstyled-componentstslibtypescript
<SmartInput>
Drop-in <input> and <textarea> replacement that that provides inline, tab-completable suggestions like GitHub Copilot and Gmail Smart Compose for any app.
The component learns from user input and makes better suggestions over time.
1import { SmartInput } from '@foundationui/smart-input' 2 3function MySmartInput() { 4 const [value, setValue] = useState('') 5 return ( 6 <SmartInput 7 placeholder="Type something..." 8 renderText={props => <span {...props} />} 9 renderCompletion={props => <span style={{ opacity: 0.4 }} {...props} />} 10 value={value} 11 onChange={setValue} 12 multiline={false} 13 /> 14 ) 15}
Examples:
Install
npm
1npm install --save @foundationui/smart-input
yarn
1yarn 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:
1<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:
1<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:
1<SmartInput 2 context={JSON.stringify({ 3 subject: 'This is too easy to integrate', 4 recipient: 'jane@doe.com', 5 })} 6/>
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.
1curl -X POST https://api.foundation-ui.com/v0/database \ 2 -H 'Content-Type: application/json' \ 3 -H 'X-Api-Key: <your api key>' \ 4 -d @- <<BODY 5{ 6 "repository": "my-org/support-widget", 7 "table": "Table1", 8 "data": [{ 9 "user": "elonmusk", 10 "context": "Subject: 'This is too easy to integrate'\nTo: 'support@foundation-ui.com'", 11 "input": "Hey, SmartInput is awesome! It only took me a couple of minutes to", 12 "output": " add it to my application." 13 }] 14} 15BODY
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:
1<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:
- (optional) Bootstrap your model with data on foundation-ui.com
- Replace one of the inputs in your app with
<SmartInput safeMode /> - 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.
:scroll: Props
model: string | undefinedThe 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 | undefinedAn 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 | undefinedData 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: stringThe controlled value of the input.
onChange: (newValue: string) => voidInvoked whenever the text value of the content changes. Use this to update the controlled
value.
renderText: (props: any) => React.ReactElementInvoked to display normal text, returns a React element. You should use an inline display element (e.g.
span) and spread props, like so:1renderText={props => <span {...props} />}You may add whatever styling you like like via
style,className, etc.
renderCompletion: (props: any) => React.ReactElementInvoked to display completion text, returns a React element. You should use an inline display element (e.g.
span) and spread props, like so:1renderCompletion={props => <span {...props} />}You may add whatever styling you like like via
style,className, etc.
renderPlaceholder: ((props: any) => React.ReactElement) | undefinedInvoked to display placeholder text, returns a React element. You should use an inline display element (e.g.
span) and spread props, like so:1renderCompletion={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 thestylefrompropslike so:1renderCompletion={props => <span {...props} style={{...props.style, color: 'red' }} />}
placeholder: string | undefinedThe text to display when value is empty. If not provided, no placeholder is displayed.
multiline: boolean | undefinedWhether or not to allow multiline text. Default
false.
onShowCompletion: ((completion: string) => void) | undefinedCalled when a non-empty completion is shown to the user.
onAcceptCompletion: ((completion: string) => void) | undefinedCalled when a non-empty completion is accepted by the user.
onBlur: React.FocusEventHandler<HTMLElement> | undefinedStandard
onBlurhandler, analogous to the one from<input>and<textarea>elements.
onFocus: React.FocusEventHandler<HTMLElement> | undefinedStandard
onFocushandler, analogous to the one from<input>and<textarea>elements.
onKeyDown: React.KeyboardEventHandler<HTMLElement> | undefinedStandard
onKeyDownhandler, analogous to the one from<input>and<textarea>elements. Note that this handler is called after any keyboard events captured by<SmartInput>(e.g.Tabto accept a suggestion).
disabled: boolean | undefinedWhether the input is editable. If
true, the input is read-only.
safeMode: boolean | undefinedWhether 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> | undefinedElement to use as the wrapper component. If not provided, the component will render as a
<div>withcontenteditable="true".
containerProps: P | undefinedProps that will get passed to the
containerelement, when one is provided.
No vulnerabilities found.
No security vulnerabilities found.