Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qonto/ember-autofocus-modifier
An {{autofocus}} modifier to use with Ember components.
https://github.com/qonto/ember-autofocus-modifier
ember ember-addon
Last synced: 3 days ago
JSON representation
An {{autofocus}} modifier to use with Ember components.
- Host: GitHub
- URL: https://github.com/qonto/ember-autofocus-modifier
- Owner: qonto
- License: mit
- Created: 2019-11-12T10:19:11.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T14:21:22.000Z (about 2 months ago)
- Last Synced: 2024-12-15T21:07:12.561Z (10 days ago)
- Topics: ember, ember-addon
- Language: TypeScript
- Homepage:
- Size: 5.19 MB
- Stars: 32
- Watchers: 11
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-autofocus-modifier
Your ember component has just been rendered. Have you ever wanted to focus an
element in the DOM right after that? Like focusing this lonely input on your
page? Or like focusing a full-screen modal's close button?
This package wraps a modifier to autofocus an element in the DOM. It works for
inputs and for other elements.
As an alternative to installing this package, you might want to consider using
[this snippet](https://github.com/qonto/ember-autofocus-modifier/blob/v0.0.1/addon/modifiers/autofocus.js).
## Usage
By default, it will search for the first non-disabled input in the dom node that it has been attached to.
You can specify a custom selector to target other element as the first positional parameter.
If no child is found, then it will try to focus the element itself.
## Examples
#### To set the autofocus to an ember component:
```handlebars
```
#### To set the autofocus to a native html element:
```handlebars
```
#### To set the autofocus to the first focusable input of an html container:
Here, `#input-2` will be focused as `input-1` is disabled:
```handlebars
```
#### To set the autofocus to something else than an input in a node's children:
Here, the autofocus will be applied to the button
```handlebars
```
#### If the autofocus is applied multiple times, the latest element will be auto-focused:
Here, the autofocus will be applied to the button
```handlebars
```
## Installation
```
yarn add -D ember-autofocus-modifier
```
or
```
npm install --save-dev ember-autofocus-modifier
```
## Compatibility
- Ember.js v3.28 or above
- Ember CLI v3.28 or above
- Node.js v18 or above
- TypeScript v5.0 or above
## TypeScript usage
The `autofocus` helper has proper [Glint](https://github.com/typed-ember/glint) types, which allow you to get strict type checking in your templates when using TypeScript.
Unless you are using [strict mode](http://emberjs.github.io/rfcs/0496-handlebars-strict-mode.html) templates (via [first class component templates](http://emberjs.github.io/rfcs/0779-first-class-component-templates.html)),
you need to import the addon's Glint template registry entries as described in the [Using Addons](https://typed-ember.gitbook.io/glint/using-glint/ember/using-addons#using-glint-enabled-addons) documentation:
```ts
// e.g. types/glint.d.ts
import "@glint/environment-ember-loose";
import type AutofocusRegistry from "ember-autofocus-modifier/template-registry";
declare module "@glint/environment-ember-loose/registry" {
export default interface Registry
extends AutofocusRegistry /* other addon registries */ {
// local entries
}
}
```
## Contributing
See the [Contributing](CONTRIBUTING.md) guide for details.
## License
This project is licensed under the [MIT License](LICENSE.md).