2.0.1 • Published 1 year ago
@georapbox/resize-observer-element v2.0.1
<resize-observer>
A custom element that offers a declarative interface to the ResizeObserver API.
Install
$ npm install --save @georapbox/resize-observer-elementUsage
Script
import { ResizeObserverElement } from './node_modules/@georapbox/resize-observer-element/dist/resize-observer.js';
// Manually define the element.
ResizeObserverElement.defineCustomElement();Alternatively, you can import the automatically defined custom element.
import './node_modules/@georapbox/resize-observer-element/dist/resize-observer-defined.js';Markup
<resize-observer>
<p>Lorem, ipsum dolor sit amet consectetur adipisicing elit.</p>
<p>Quas quo aliquam iure ipsa laborum! Deleniti doloremque quaerat sunt, esse fugit.</p>
<p>Molestias, libero laborum minus facere ullam iusto eius in adipisci quaerat autem placeat quisquam.</p>
</resize-observer>API
Properties
| Name | Reflects | Type | Default | Description |
|---|---|---|---|---|
disabled | ✓ | Boolean | false | Defines if the resize observer is disabled or not. |
Slots
| Name | Description |
|---|---|
| (default) | The default slot where the elements to observe are placed. |
Methods
| Name | Type | Description | Arguments |
|---|---|---|---|
defineCustomElement | Static | Defines/registers the custom element with the name provided. If no name is provided, the default name is used. The method checks if the element is already defined, hence will skip trying to redefine it. | elementName='resize-observer' |
Events
| Name | Description | Event Detail |
|---|---|---|
resize-observer:resize | Emitted when the element is resized. | { entries: ResizeObserverEntry[] |
Changelog
For API updates and breaking changes, check the CHANGELOG.
Development setup
Prerequisites
The project requires Node.js and npm to be installed on your environment. Preferrably, use nvm Node Version Manager and use the version of Node.js specified in the .nvmrc file by running nvm use.
Install dependencies
Install the project dependencies by running the following command.
npm installBuild for development
Watch for changes and start a development server by running the following command.
npm startLinting
Lint the code by running the following command.
npm run lintTesting
Run the tests by running any of the following commands.
npm test
npm run test:watch # watch modeBuild for production
Create a production build by running the following command.
npm run build