@copart/notes-component
Advanced tools
@copart/notes-component - npm Package Compare versions
Comparing version 0.0.10 to 0.0.11
| { | ||
| "name": "@copart/notes-component", | ||
| "version": "0.0.10", | ||
| "version": "0.0.11", | ||
| "main": "dist/display-notes.js", | ||
@@ -5,0 +5,0 @@ "files": [ |
@@ -11,3 +11,3 @@ # Ops Notes Component Library | ||
| | ---------------- | -------- | -------- | --------------- | ---------------------------------------------------------------------------------------------------- | | ||
| | notes | object | Yes | | Notes object containing all notes | | ||
| | notes | Object | Yes | | Notes object containing all notes | | ||
| | handleNewSubmit | Function | Yes | | Function that fires when submitting a new note. Takes in input string | | ||
@@ -24,3 +24,3 @@ | timeZone | string | No | 'Europe/Berlin' | Current timezone to correctly display timestamps through moment-timezone | | ||
| | 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 | | ||
| | 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 | | ||
@@ -30,2 +30,3 @@ | stickyHeader | boolean | No | true | Enable sticky headers for every note to help user maintain context on long notes | | ||
| | disableNewNote | boolean | No | false | Whether or not to show new note input | | ||
| | translations | Object | No | | Translations for localization | | ||
@@ -42,2 +43,3 @@ ## Code Example | ||
| import { exampleNotes } from './exampleNotes' | ||
| import exampleTranslationsMap from './exampleTranslationsMap' | ||
@@ -80,2 +82,3 @@ class App extends React.Component { | ||
| timeZone="Europe/Berlin" | ||
| translations={exampleTranslationsMap} | ||
| /> | ||
@@ -95,3 +98,2 @@ ) | ||
| import exampleStages from './exampleStages' | ||
| import exampleTranslationsMap from './exampleTranslationsMap' | ||
@@ -106,3 +108,2 @@ // Example notes object | ||
| stages: exampleStages, // translate stages to readable text | ||
| translations: exampleTranslationsMap, // find translation for field key | ||
| fieldMap: exampleFieldMap, // link field key provided to correct key in translations | ||
@@ -109,0 +110,0 @@ data: [ |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Improved metrics
- Number of lines in readme file
- increased by0.46%
218
Worsened metrics
- Total package byte prevSize
- decreased by-0.01%
3464175