Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@copart/notes-component
Advanced tools
@copart/notes-component - npm Package Compare versions
Comparing version 0.1.2 to 0.2.0
| { | ||
| "name": "@copart/notes-component", | ||
| "version": "0.1.2", | ||
| "version": "0.2.0", | ||
| "main": "dist/display-notes.js", | ||
@@ -5,0 +5,0 @@ "files": [ |
@@ -9,27 +9,28 @@ # 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 | | ||
| | 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 | | ||
| | translations | Object | No | | Translations for localization | | ||
| | handleScrollEnd | Function | No | | Function to handle the end of scroll in notes | | ||
| | onChangeNote | Function | No | | Function to handle change of note | | ||
| | reverseList | boolean | No | true | Flag to determine if the list has to be reversed | | ||
| | loadNextPage | boolean | No | false | Flag to determine if the next page list needs to be fetched | | ||
| | disabled | boolean | No | false | Disables the note button | | ||
| | 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 | moment.tz.guess() | Current timezone to correctly display timestamps through moment-timezone (by default will try to guess user's timezone based on browser) | | ||
| | 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 | | ||
| | translations | Object | No | | Translations for localization | | ||
| | handleScrollEnd | Function | No | | Function to handle the end of scroll in notes | | ||
| | onChangeNote | Function | No | | Function to handle change of note | | ||
| | reverseList | boolean | No | true | Flag to determine if the list has to be reversed | | ||
| | loadNextPage | boolean | No | false | Flag to determine if the next page list needs to be fetched | | ||
| | disabled | boolean | No | false | Disables the note button | | ||
| | timeFormat | boolean | No | 'MMM Do [']YY h:mma z' | Change the format of the date and time (use moment supported formats: https://momentjs.com/docs/#/parsing/string-format/ ) | | ||
@@ -85,2 +86,4 @@ ## Code Example | ||
| translations={exampleTranslationsMap} | ||
| // twentyFourHourTime={true} | ||
| // disabled={true} | ||
| /> | ||
@@ -87,0 +90,0 @@ ) |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.05%
3472058
- Number of lines in readme file
- increased by1.34%
227
Worsened metrics
- Number of downloads
- decreased by-33.33%
108
No dependency changes