Skip to content

Commit

Permalink
Merge pull request #10 from DHTMLX/mr-next-combobox-accessibility-4586
Browse files Browse the repository at this point in the history
[add] resetfocus(), update focuschange events for list and dataview
  • Loading branch information
mafanya23 authored Jul 12, 2024
2 parents 577c89f + 29617b1 commit 299852e
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 8 deletions.
1 change: 1 addition & 0 deletions docs/dataview/api/api_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ description: You can explore the API of DataView in the documentation of the DHT
| [](dataview/api/dataview_getfocus_method.md) | @getshort(dataview/api/dataview_getfocus_method.md) |
| [](dataview/api/dataview_getfocusitem_method.md) | @getshort(dataview/api/dataview_getfocusitem_method.md) |
| [](dataview/api/dataview_paint_method.md) | @getshort(dataview/api/dataview_paint_method.md) |
| [](dataview/api/dataview_resetfocus_method.md) | @getshort(dataview/api/dataview_resetfocus_method.md) |
| [](dataview/api/dataview_setfocus_method.md) | @getshort(dataview/api/dataview_setfocus_method.md) |

:::info important
Expand Down
13 changes: 9 additions & 4 deletions docs/dataview/api/dataview_focuschange_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,22 @@ description: You can explore the focusChange event of DataView in the documentat

@short: fires on moving focus to a new item

@signature: {'focusChange: (focusIndex: number, id: string | number) => void;'}
@signature: {'focusChange: (focusIndex?: number, id?: string | number) => void;'}

@params:
- `focusIndex: number` - the position of an item in focus
- `id: string | number` - the id of the item
The callback of the **focusChange** event is called with the following parameters:

- `focusIndex` - (optional) the position of an item in focus
- `id` - (optional) the id of the item

@example:
dataview.events.on("focusChange", function(index, id){
dataview.events.on("focusChange", function(focusIndex, id){
// your code here
});

@descr:

**Related sample**: [Dataview. Events](https://snippet.dhtmlx.com/2d74uyoh)

@changelog:
- Parameters of the callback function became optional in v8.3.14
20 changes: 20 additions & 0 deletions docs/dataview/api/dataview_resetfocus_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_label: resetFocus()
title: JavaScript DataView - resetFocus Method
description: You can explore the resetFocus method of DataView in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
---

# resetFocus()

@short: resets focus and moves the scroll to the beginning of the dataview

@signature: {'resetFocus(): void;'}

@example:
dataview.resetFocus();

@descr:


@changelog:
added in v8.4
1 change: 1 addition & 0 deletions docs/list/api/api_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ description: You can explore the API of List in the documentation of the DHTMLX
| [](list/api/list_getfocus_method.md) | @getshort(list/api/list_getfocus_method.md) |
| [](list/api/list_getfocusitem_method.md) | @getshort(list/api/list_getfocusitem_method.md) |
| [](list/api/list_paint_method.md) | @getshort(list/api/list_paint_method.md) |
| [](list/api/list_resetfocus_method.md) | @getshort(list/api/list_resetfocus_method.md) |
| [](list/api/list_setfocus_method.md) | @getshort(list/api/list_setfocus_method.md) |

:::info important
Expand Down
13 changes: 9 additions & 4 deletions docs/list/api/list_focuschange_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,22 @@ description: You can explore the focusChange event of List in the documentation

@short: fires on moving focus to a new item

@signature: {'focusChange: (focusIndex: number, id: string | number) => void;'}
@signature: {'focusChange: (focusIndex?: number, id?: string | number) => void;'}

@params:
- `focusIndex: number` - the position of an item
- `id: string | number` - the id of an item
The callback of the **focusChange** event is called with the following parameters:

- `focusIndex` - (optional) the position of an item
- `id` - (optional) the id of an item

@example:
list.events.on("focusChange", function(index, id){
list.events.on("focusChange", function(focusIndex, id){
// your code here
});

@descr:

**Related sample**: [List. Events](https://snippet.dhtmlx.com/iwt1yd61)

@changelog:
- Parameters of the callback function became optional in v8.3.14
20 changes: 20 additions & 0 deletions docs/list/api/list_resetfocus_method.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
sidebar_label: resetFocus()
title: JavaScript List - resetFocus Method
description: You can explore the resetFocus method of List in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
---

# resetFocus()

@short: resets focus and moves the scroll to the beginning of the list

@signature: {'resetFocus(): void;'}

@example:
list.resetFocus();

@descr:


@changelog:
added in v8.4
2 changes: 2 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,7 @@ module.exports = {
"dataview/api/dataview_getfocus_method",
"dataview/api/dataview_getfocusitem_method",
"dataview/api/dataview_paint_method",
"dataview/api/dataview_resetfocus_method",
"dataview/api/dataview_setfocus_method",
],
},
Expand Down Expand Up @@ -2992,6 +2993,7 @@ module.exports = {
"list/api/list_getfocus_method",
"list/api/list_getfocusitem_method",
"list/api/list_paint_method",
"list/api/list_resetfocus_method",
"list/api/list_setfocus_method",
],
},
Expand Down

0 comments on commit 299852e

Please sign in to comment.