@copart/notes-component
Advanced tools
Comparing version 0.0.52 to 0.0.71
{ | ||
"name": "@copart/notes-component", | ||
"version": "0.0.52", | ||
"version": "0.0.71", | ||
"main": "dist/display-notes.js", | ||
@@ -46,2 +46,3 @@ "files": [ | ||
"moment": "^2.22.2", | ||
"moment-timezone": "^0.5.21", | ||
"node-sass": "^4.9.0", | ||
@@ -48,0 +49,0 @@ "postcss": "^6.0.22", |
@@ -9,18 +9,21 @@ # Ops Notes Component Library | ||
| Name | Type | Required | Default | Description | | ||
| ---------------- | -------- | -------- | -------------- | ---------------------------------------------------------------------------------------------------- | | ||
| notes | object | Yes | | Notes object containing all notes | | ||
| handleNewSubmit | Function | Yes | | Function that fires when submitting a new note. Takes in input string | | ||
| onOpen | Function | No | | Function that fires whenever the notes module is opened | | ||
| loadingNotes | boolean | No | false | Pass true when loading notes and false when finished, for spinner | | ||
| title | string | No | '00000000' | Title for the header following the prefix | | ||
| titlePrefix | string | No | 'Lot#' | Prefix for the header | | ||
| searchTypeKey | string | No | 'lotNotes' | Default search key for searchbar dropdown. (Must match a key on the object passed to the notes prop) | | ||
| buttonText | string | No | 'Notes' | Text for the closed notes button | | ||
| keyboardShortcut | string | No | 'F6' | Keyboard key to open the notes modules | | ||
| bounds | string | No | 'body' | Restriction for the draggable area of the open notes module | | ||
| defaultPosition | object | No | { x: 0, y: 0 } | Default x and y position of the open notes module when it is first opened | | ||
| autoSearch | boolean | No | true | Automatically search notes every time user types in searchbox rather than on search button click | | ||
| stickyHeader | boolean | No | true | Enable sticky headers for every note to help user maintain context on long notes | | ||
| defaultOpen | boolean | No | false | Whether or not notes are open by default on component load | | ||
| Name | Type | Required | Default | Description | | ||
| ---------------- | -------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------- | | ||
| notes | object | Yes | | Notes object containing all notes | | ||
| handleNewSubmit | Function | Yes | | Function that fires when submitting a new note. Takes in input string | | ||
| timeZone | string | No | 'Europe/Berlin' | Current timezone to correctly display timestamps through moment-timezone | | ||
| onOpen | Function | No | | Function that fires whenever the notes module is opened | | ||
| onClose | Function | No | | Function that fires whenever the notes module is closed | | ||
| loadingNotes | boolean | No | false | Pass true when loading notes and false when finished, for spinner | | ||
| title | string | No | '00000000' | Title for the header following the prefix | | ||
| titlePrefix | string | No | 'Lot#' | Prefix for the header | | ||
| searchTypeKey | string | No | 'lotNotes' | Default search key for searchbar dropdown. (Must match a key on the object passed to the notes prop) | | ||
| buttonText | string | No | 'Notes' | Text for the closed notes button | | ||
| keyboardShortcut | string | No | 'F6' | Keyboard key to open the notes modules | | ||
| bounds | string | No | 'body' | Restriction for the draggable area of the open notes module | | ||
| defaultPosition | object | No | { x: 0, y: 0 } | Default x and y position of the open notes module when it is first opened | | ||
| autoSearch | boolean | No | true | Automatically search notes every time user types in searchbox rather than on search button click | | ||
| stickyHeader | boolean | No | true | Enable sticky headers for every note to help user maintain context on long notes | | ||
| defaultOpen | boolean | No | false | Whether or not notes are open by default on component load | | ||
| disableNewNote | boolean | No | false | Whether or not to show new note input | | ||
@@ -73,2 +76,3 @@ ## Code Example | ||
searchTypeKey="noteTypeKey2" | ||
timeZone="Europe/Berlin" | ||
/> | ||
@@ -75,0 +79,0 @@ ) |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
3462603
2536
217
49