https://github.com/zestia/ember-auto-focus

:eyeglasses: An autofocus solution for Ember apps
https://github.com/zestia/ember-auto-focus

autofocus-element ember

Last synced: 5 days ago
JSON representation

:eyeglasses: An autofocus solution for Ember apps

• Host: GitHub
• URL: https://github.com/zestia/ember-auto-focus
• Owner: zestia
• License: mit
• Created: 2016-01-11T14:30:47.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T12:30:29.000Z (14 days ago)
• Last Synced: 2024-10-22T19:45:06.132Z (14 days ago)
• Topics: autofocus-element, ember
• Language: JavaScript
• Homepage:
• Size: 10.1 MB
• Stars: 22
• Watchers: 17
• Forks: 3
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# @zestia/ember-auto-focus

[![Ember Observer][ember-observer-badge]][ember-observer-url]

[npm-badge]: https://img.shields.io/npm/v/@zestia/ember-auto-focus.svg

[npm-badge-url]: https://www.npmjs.com/package/@zestia/ember-auto-focus

[github-actions-badge]: https://github.com/zestia/ember-auto-focus/workflows/CI/badge.svg

[github-actions-url]: https://github.com/zestia/ember-auto-focus/actions

[ember-observer-badge]: https://emberobserver.com/badges/-zestia-ember-auto-focus.svg

[ember-observer-url]: https://emberobserver.com/addons/@zestia/ember-auto-focus

HTML's `autofocus` attribute focuses an element on the first occurrence of the attribute. But, does nothing on subsequent renders of the same element.

This addon provides an element modifier, which auto focuses the element when it is inserted into the DOM.

## Installation

```

ember install @zestia/ember-auto-focus

```

Add the following to `~/.npmrc` to pull @zestia scoped packages from Github instead of NPM.

```

@zestia:registry=https://npm.pkg.github.com

//npm.pkg.github.com/:_authToken=

```

## Demo

https://zestia.github.io/ember-auto-focus

## Example

```handlebars

{{#if this.showField}}

  

{{/if}}

```

## `{{auto-focus}}`

### Arguments

#### `selector`

Optional. This _positional_ argument allows you to auto focus a child element. Useful for occasions when you don't have access to the children.

  Example

```handlebars

```

#### `disabled`

Optional. This _named_ argument turns off auto focusing. Note that this behaviour can now also be achieved with a conditional modifier (this wasn't always the case).

#### `options`

Optional. _Any other named arguments_ are passed to the `focus` method. Some options available include `preventScroll` and `focusVisible`

## Notes

This modifier has certain benefits over other implementations:

1. It waits until after render, so that in your actions you can be sure `document.activeElement` is as you'd expect ([Example](https://github.com/zestia/ember-auto-focus/blob/845ea30035aa55fb69164e9eb9001c6fe08fa73b/tests/integration/modifiers/auto-focus-test.js#L86-L98)).

2. It compensates for the fact that child modifiers run their installation before parents in the DOM tree. So nesting `{{auto-focus}}` will work as you would expect. ([Example](https://github.com/zestia/ember-auto-focus/blob/845ea30035aa55fb69164e9eb9001c6fe08fa73b/tests/integration/modifiers/auto-focus-test.js#L100-L114)).

3. It allows you to differentiate between an element that was focused by a user interacting with it, and an element that was focused programmatically. Through `element.dataset.programmaticallyFocused`. ([Example](https://github.com/zestia/ember-auto-focus/blob/8ba15763e5b21e5cc7924339dd65521c965ce722/tests/integration/modifiers/auto-focus-test.js#L116-L144))