basic-arrow-selection - npm Package Compare versions

Comparing version 0.7.4 to 0.7.5

package.json

 {
   "name": "basic-arrow-selection",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "description": "Mixin used to add prominent left and right arrow buttons to a wrapped child. Clicking the left/right buttons selects the previous/next item.",
@@ -16,4 +16,4 @@ "homepage": "https://component.kitchen",
   "dependencies": {
-    "basic-element-base": "^0.7.4",
-    "basic-component-mixins": "^0.7.4"
+    "basic-element-base": "^0.7.5",
+    "basic-component-mixins": "^0.7.5"
   },
@@ -20,0 +20,0 @@ "browserify": {

README.md

@@ -0,1 +1,2 @@
+# API Documentation
 <a name="ArrowSelection"></a>
@@ -24,4 +25,272 @@ ## ArrowSelection ⇐ <code>ElementBase</code>
 
-**Kind**: global class  
+  **Kind**: global class
 **Extends:** <code>ElementBase</code>  
-**Mixes**: <code>ContentFirstChildTarget</code>, <code>DirectionSelection</code>, <code>DistributedChildrenAsContent</code>, <code>ItemsSelection</code>, <code>Keyboard</code>, <code>KeyboardDirection</code>, <code>TargetInCollective</code>, <code>TargetInCollective</code>, <code>TargetSelection</code>  
+**Mixes**: <code>[ContentFirstChildTarget](../basic-component-mixins/docs/ContentFirstChildTarget.md)</code>
+  , <code>[DirectionSelection](../basic-component-mixins/docs/DirectionSelection.md)</code>
+  , <code>[DistributedChildrenAsContent](../basic-component-mixins/docs/DistributedChildrenAsContent.md)</code>
+  , <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code>
+  , <code>[Keyboard](../basic-component-mixins/docs/Keyboard.md)</code>
+  , <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code>
+  , <code>[TargetInCollective](../basic-component-mixins/docs/TargetInCollective.md)</code>
+  , <code>[TargetInCollective](../basic-component-mixins/docs/TargetInCollective.md)</code>
+  , <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code>
+  
+
+* [ArrowSelection](#ArrowSelection) ⇐ <code>ElementBase</code>
+    * [.applySelection(item, selected)](#ItemsSelection+applySelection)
+    * [.canSelectNext](#ItemsSelection+canSelectNext) : <code>boolean</code>
+    * [.canSelectPrevious](#ItemsSelection+canSelectPrevious) : <code>boolean</code>
+    * [.content](#DistributedChildrenAsContent+content) : <code>Array.&lt;HTMLElement&gt;</code>
+    * [.goDown()](#KeyboardDirection+goDown)
+    * [.goEnd()](#KeyboardDirection+goEnd)
+    * [.goLeft()](#KeyboardDirection+goLeft)
+    * [.goRight()](#KeyboardDirection+goRight)
+    * [.goStart()](#KeyboardDirection+goStart)
+    * [.goUp()](#KeyboardDirection+goUp)
+    * [.itemAdded(item)](#ItemsSelection+itemAdded)
+    * [.items](#TargetSelection+items) : <code>Array.&lt;HTMLElement&gt;</code>
+    * [.itemsChanged()](#TargetSelection+itemsChanged)
+    * [.keydown(event)](#Keyboard+keydown) ⇒ <code>boolean</code>
+    * [.navigationAxis](#KeyboardDirection+navigationAxis) : <code>string</code>
+    * ["selected-index-changed"](#ItemsSelection.event_selected-index-changed)
+    * ["selected-item-changed"](#ItemsSelection.event_selected-item-changed)
+    * [.selectedIndex](#TargetSelection+selectedIndex) : <code>number</code>
+    * [.selectedIndex](#ItemsSelection+selectedIndex) : <code>number</code>
+    * [.selectedItem](#TargetSelection+selectedItem) : <code>HTMLElement</code>
+    * [.selectedItem](#ItemsSelection+selectedItem) : <code>object</code>
+    * [.selectFirst()](#ItemsSelection+selectFirst)
+    * [.selectionRequired](#ItemsSelection+selectionRequired) : <code>boolean</code>
+    * [.selectLast()](#ItemsSelection+selectLast)
+    * [.selectNext()](#ItemsSelection+selectNext)
+    * [.selectPrevious()](#ItemsSelection+selectPrevious)
+    * [.target](#TargetInCollective+target) : <code>HTMLElement</code>
+    * [.target](#ContentFirstChildTarget+target) : <code>HTMLElement</code>
+    * [.target](#TargetSelection+target) : <code>HTMLElement</code>
+    * [.target](#TargetInCollective+target) : <code>HTMLElement</code>
+
+<a name="ItemsSelection+applySelection"></a>
+### arrowSelection.applySelection(item, selected)
+Apply the indicate selection state to the item.
+
+The default implementation of this method does nothing. User-visible
+effects will typically be handled by other mixins.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>HTMLElement</code> | the item being selected/deselected |
+| selected | <code>boolean</code> | true if the item is selected, false if not |
+
+<a name="ItemsSelection+canSelectNext"></a>
+### arrowSelection.canSelectNext : <code>boolean</code>
+True if the selection can be moved to the next item, false if not (the
+selected item is the last item in the list).
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+canSelectPrevious"></a>
+### arrowSelection.canSelectPrevious : <code>boolean</code>
+True if the selection can be moved to the previous item, false if not
+(the selected item is the first one in the list).
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="DistributedChildrenAsContent+content"></a>
+### arrowSelection.content : <code>Array.&lt;HTMLElement&gt;</code>
+The content of this component, defined to be the flattened array of
+children distributed to the component.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[DistributedChildrenAsContent](../basic-component-mixins/docs/DistributedChildrenAsContent.md)</code> mixin.
+<a name="KeyboardDirection+goDown"></a>
+### arrowSelection.goDown()
+Invoked when the user wants to go/navigate down.
+The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="KeyboardDirection+goEnd"></a>
+### arrowSelection.goEnd()
+Invoked when the user wants to go/navigate to the end (e.g., of a list).
+The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="KeyboardDirection+goLeft"></a>
+### arrowSelection.goLeft()
+Invoked when the user wants to go/navigate left.
+The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="KeyboardDirection+goRight"></a>
+### arrowSelection.goRight()
+Invoked when the user wants to go/navigate right.
+The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="KeyboardDirection+goStart"></a>
+### arrowSelection.goStart()
+Invoked when the user wants to go/navigate to the start (e.g., of a
+list). The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="KeyboardDirection+goUp"></a>
+### arrowSelection.goUp()
+Invoked when the user wants to go/navigate up.
+The default implementation of this method does nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="ItemsSelection+itemAdded"></a>
+### arrowSelection.itemAdded(item)
+Handle a new item being added to the list.
+
+The default implementation of this method simply sets the item's
+selection state to false.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| item | <code>HTMLElement</code> | the item being added |
+
+<a name="TargetSelection+items"></a>
+### arrowSelection.items : <code>Array.&lt;HTMLElement&gt;</code>
+The current set of items in the list.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code> mixin.
+<a name="TargetSelection+itemsChanged"></a>
+### arrowSelection.itemsChanged()
+This method is invoked when the underlying contents change. It is also
+invoked on component initialization – since the items have "changed" from
+being nothing.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code> mixin.
+<a name="Keyboard+keydown"></a>
+### arrowSelection.keydown(event) ⇒ <code>boolean</code>
+Handle the indicated keyboard event.
+
+The default implementation of this method does nothing. This will
+typically be handled by other mixins.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[Keyboard](../basic-component-mixins/docs/Keyboard.md)</code> mixin.
+**Returns**: <code>boolean</code> - true if the event was handled  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>KeyboardEvent</code> | the keyboard event |
+
+<a name="KeyboardDirection+navigationAxis"></a>
+### arrowSelection.navigationAxis : <code>string</code>
+Indicates the direction of permitted navigation with the keyboard.
+
+Accepted values are "horizontal", "vertical", or "both" (the default).
+If this property is "horizontal", the Up Arrow and Down Arrow keys will
+be ignored. Conversely, if this is "vertical", the Left Arrow and Right
+Arrow keys will be ignored.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[KeyboardDirection](../basic-component-mixins/docs/KeyboardDirection.md)</code> mixin.
+<a name="ItemsSelection.event_selected-index-changed"></a>
+### "selected-index-changed"
+Fires when the selectedIndex property changes.
+
+  **Kind**: event emitted by <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| detail.selectedIndex | <code>number</code> | The new selected index. |
+
+<a name="ItemsSelection.event_selected-item-changed"></a>
+### "selected-item-changed"
+Fires when the selectedItem property changes.
+
+  **Kind**: event emitted by <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| detail.selectedItem | <code>HTMLElement</code> | The new selected item. |
+| detail.previousItem | <code>HTMLElement</code> | The previously selected item. |
+
+<a name="TargetSelection+selectedIndex"></a>
+### arrowSelection.selectedIndex : <code>number</code>
+The index of the item which is currently selected, or -1 if there is no
+selection.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code> mixin.
+<a name="ItemsSelection+selectedIndex"></a>
+### arrowSelection.selectedIndex : <code>number</code>
+The index of the item which is currently selected, or -1 if there is no
+selection.
+
+Setting the index to -1 deselects any current-selected item.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="TargetSelection+selectedItem"></a>
+### arrowSelection.selectedItem : <code>HTMLElement</code>
+The currently selected item, or null if there is no selection.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code> mixin.
+<a name="ItemsSelection+selectedItem"></a>
+### arrowSelection.selectedItem : <code>object</code>
+The currently selected item, or null if there is no selection.
+
+Setting this property to null deselects any currently-selected item.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+selectFirst"></a>
+### arrowSelection.selectFirst()
+Select the first item in the list.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+selectionRequired"></a>
+### arrowSelection.selectionRequired : <code>boolean</code>
+True if the list should always have a selection (if it has items).
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+selectLast"></a>
+### arrowSelection.selectLast()
+Select the last item in the list.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+selectNext"></a>
+### arrowSelection.selectNext()
+Select the next item in the list.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="ItemsSelection+selectPrevious"></a>
+### arrowSelection.selectPrevious()
+Select the previous item in the list.
+
+  **Kind**: instance method of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ItemsSelection](../basic-component-mixins/docs/ItemsSelection.md)</code> mixin.
+<a name="TargetInCollective+target"></a>
+### arrowSelection.target : <code>HTMLElement</code>
+Gets/sets the current target of the component.
+
+Set this to point to another element. That target element will be
+implicitly added to the component's collective. That is, the component
+and its target will share responsibility for handling keyboard events.
+
+You can set this property yourself, or you can use the
+ContentFirstChildTarget mixin to automatically set the target to the
+component's first child.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetInCollective](../basic-component-mixins/docs/TargetInCollective.md)</code> mixin.
+<a name="ContentFirstChildTarget+target"></a>
+### arrowSelection.target : <code>HTMLElement</code>
+Gets/sets the current target of the component.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[ContentFirstChildTarget](../basic-component-mixins/docs/ContentFirstChildTarget.md)</code> mixin.
+<a name="TargetSelection+target"></a>
+### arrowSelection.target : <code>HTMLElement</code>
+Gets/sets the target element to which this component will delegate
+selection actions.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetSelection](../basic-component-mixins/docs/TargetSelection.md)</code> mixin.
+<a name="TargetInCollective+target"></a>
+### arrowSelection.target : <code>HTMLElement</code>
+Gets/sets the current target of the component.
+
+Set this to point to another element. That target element will be
+implicitly added to the component's collective. That is, the component
+and its target will share responsibility for handling keyboard events.
+
+You can set this property yourself, or you can use the
+ContentFirstChildTarget mixin to automatically set the target to the
+component's first child.
+
+  **Kind**: instance property of <code>[ArrowSelection](#ArrowSelection)</code>. Defined by <code>[TargetInCollective](../basic-component-mixins/docs/TargetInCollective.md)</code> mixin.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

278608

increased by5.87%

Lines of code

3084

increased by0.1%

Number of lines in readme file

296

increased by996.3%

Dependency changes

• Updatedbasic-component-mixins@^0.7.5

• Updatedbasic-element-base@^0.7.5