dropdowns-js 1.0.0 → 1.0.2

package/README.md

@@ -12,8 +12,8 @@ Searchable dropdown components for React applications.
 npm install dropdowns-js
 ```  
   
-## 1. Wrap your App
-All components must be wrapped in the CollectionsProvider to manage the dropdown states.
+## 1. Wrap your Component
+All components must be separately wrapped in the CollectionsProvider to manage the dropdown states.
 
 ```
 // App.jsx
@@ -59,7 +59,7 @@ export default function MyComponent {
 }
 ``` 
 **Context functions**  
-`addCollection(collectionName, anArray, maxNumSelections = null, primitiveType = true, ...sortFields)` 
+`addCollection(collectionName, anArray, maxNumSelections = null, primitiveType = true, ...sortFields)`  
 Add a new collection of data to be displayed in a dropdown for selection.  
   
 
@@ -81,10 +81,19 @@ Get the selected items (array) of the specified collection. An error is thrown f
 `getMaxNumSelections(collectionName)`  
 Get the maximum number of items that can be selected on this collection. An error is thrown for a non-existent collection name is specified.  
   
-## 3. DropdownStyle and ButtonStyle
-- The DropdownStyle attribute must be provided with an object with field values { color, backgroundColor }.
-- The ButtonStyle attribute must be provided also provided an object with field values { color, backgroundColor }
-    
+## 3. Dropdown Component Attributes
+`label` - to be used for aria-label.  
+  
+`isDisabled` - disables the component when set to true. Default = false.  
+  
+`collectionName` - name of the collection to populate the dropdown.  
+  
+`dropdownStyle` - for providing styling the dropdown. Fields: {color, backgroundColor}.  
+  
+`buttonStyle` - for providing styling the DONE button (pressed after completing selection in multi-selection dropdowns). Fields: {color, backgroundColor}.  
+  
+`onItemSelected` - a providing a method to execute on selection of items.
+  
 ## 4. Dropdown usage example
 This dropdown is to be used when the underlying data is a primitive type array.  
 ```  
@@ -347,7 +356,7 @@ export default function MyComponent4() {
     );
 }
 ```  
-### 8. Multiple dropdown usage example
+## 8. Multiple dropdown usage example
 ```
 export default function MyComponent5() {
     const [output, setOutput] = useState();

package/package.json

@@ -3,7 +3,7 @@
   "author": "ITA",
   "description": "A React library providing customizable search dropdown components with single and multi-selection capabilities.",
   "private": false,
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "module": "dist/dropdowns-js.es.js",
   "main": "dist/dropdowns-js.cjs.js",