Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Raiper34/ngx-focus-control
Library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility.
https://github.com/Raiper34/ngx-focus-control
accessibility angular directives focus
Last synced: 24 days ago
JSON representation
Library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility.
- Host: GitHub
- URL: https://github.com/Raiper34/ngx-focus-control
- Owner: Raiper34
- License: mit
- Created: 2021-09-27T21:33:49.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T18:33:25.000Z (9 months ago)
- Last Synced: 2024-11-07T18:01:16.984Z (about 1 month ago)
- Topics: accessibility, angular, directives, focus
- Language: TypeScript
- Homepage: https://ngx-focus-control.netlify.app
- Size: 3.55 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - ngx-focus-control - Library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-focus-control - Library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-focus-control - Library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility. (Table of contents / Third Party Components)
README
[](https://badge.fury.io/js/ngx-focus-control)
[](https://circleci.com/gh/Raiper34/ngx-focus-control)
[](https://coveralls.io/github/Raiper34/ngx-focus-control?branch=main)
[](https://github.com/Raiper34/ngx-focus-control/issues)
[](https://ngx-focus-control.netlify.app/)
[](https://stackblitz.com/edit/angular-ivy-nsumon)
[](https://gitter.im/ngx-focus-control/community?source=orgpage)
# Ngx Focus Control
Angular library to provide tools to work with focus and focusable elements to improve user interfaces and accessibility.
# Version compatibility
| Angular version | Ngx focus control version |
|-----------------|---------------------------|
| 8 - 13 | 0.0.0 - 3.x.x |
| 14 | 4.x.x |
| 15 | 5.x.x |
# Instalation
`npm install ngx-focus-control --save`
then add `NgxFocusControlModule` into module imports
```typescript
import {NgxFocusControlModule} from 'ngx-focus-control';
@NgModule({
// ...
imports: [
// ...
NgxFocusControlModule,
// ...
],
// ...
})
```
# Usage
See [DEMO](https://ngx-focus-control.netlify.app/) app for usage.
# Directives
- ### Focus auto directive
auto-focuses element when an element is created, a page is visited, or delay data bidding is changed. Users can define delay of focus. 0 is the default delay when a delay is not specified.
```html
```
- ### Focus control directive
allows the user to manually define the next and/or previous focus target.
```html
```
- ### Focus selector directive
allows the user to manually define the next and previous focus target by the given query selector.
```html
```
- ### Focus group directive
allows merging focusable elements into the group. The user focuses the whole group and can enter into this group by Enter press and leave the group by Escape press.
```html
Group
```
- ### Focus lock directive
locks some area (div, span...). The first and last focusable child of the directive element are connected together (the next focus target of the last child is the first child and vice versa), useful for accessible modals.
```html
```
- ### Focus if directive
focuses the element when condition bidding changes to True or blurs the element when condition bidding changes to False. Instead of primitive value, you can also pass observable, which focuses element when observable emits True and blur element when observable emits False.
```html
```
- ### Focus switch directives
on parent element with some variable focuses child element with the value provided in focus case directive that matches. It matches the first element from top to bottom. If there is no match and you use the focus default directive, the element with this directive is focused. Value needs to change, to focus the element (if the switch variable has got value 0, and you set the variable again to 0, the element will not be focused). You can also pass observable into focus switch directive (works similar as in focus if directive).
```html
Focus Input 1
Focus Input 2
Focus Input 3
Switch to non-existing value
```
- ### Focus history directive
stores focused elements into history and thanks to history service `FocusHistoryService` you can go back in focus history using `focusHistoryService.focusPrevious()`.
```html
Focus previous
```
```ts
import {FocusHistoryService} from 'ngx-focus-control';
...
constructor(public readonly focusHistoryService: FocusHistoryService) { }
```
- ### Focus unleavable directive
does not allow leaving a focusable element when the provided condition is met.
```html
```
# License
MIT