Skip to content

Commit 32d215e

Browse files
committed
Better README and fix type
1 parent afbe435 commit 32d215e

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,13 @@
33
RichResultField is a text field that can be overlaid with a similar-looking box containing arbitrary text. Useful if you want to save a particular value from a picker but display something more friendly from the user.
44

55
Requires Bootstrap.
6+
7+
Example usage:
8+
9+
```aiignore
10+
import RichResultField from '@universityofwarwick/rich-result-field';
11+
12+
const input = document.getElementById('input');
13+
const richResultField = new RichResultField(input);
14+
richResultField.store('input-value', 'Disaplay text');
15+
```

lib/rich-result-field.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
*/
88
export default class RichResultField {
99
$input: JQuery<HTMLElement>;
10-
$uneditables: JQuery<HTMLElement>;
10+
$uneditable: JQuery<HTMLElement>;
1111
constructor(input: HTMLElement);
1212
/** Clear field, focus for typing */
1313
edit(): void;

0 commit comments

Comments
 (0)