-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
beb3d1a
commit 56d89c3
Showing
7 changed files
with
105 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
--- | ||
order: 3 | ||
title: Resize | ||
description: An Alpine convenience wrapper for the Resize Observer API that allows you to easily react when an element is resized. | ||
graph_image: https://alpinejs.dev/social_resize.jpg | ||
--- | ||
|
||
# Resize Plugin | ||
|
||
Alpine's Resize plugin is a convenience wrapper for the [Resize Observer](https://developer.mozilla.org/en-US/docs/Web/API/Resize_Observer_API) that allows you to easily react when an element changes size. | ||
|
||
This is useful for: custom size-based animations, intelligent sticky positioning, conditionally adding attributes based on the element's size, etc. | ||
|
||
<a name="installation"></a> | ||
## Installation | ||
|
||
You can use this plugin by either including it from a `<script>` tag or installing it via NPM: | ||
|
||
### Via CDN | ||
|
||
You can include the CDN build of this plugin as a `<script>` tag, just make sure to include it BEFORE Alpine's core JS file. | ||
|
||
```alpine | ||
<!-- Alpine Plugins --> | ||
<script defer src="https://cdn.jsdelivr.net/npm/@alpinejs/resize@3.x.x/dist/cdn.min.js"></script> | ||
<!-- Alpine Core --> | ||
<script defer src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js"></script> | ||
``` | ||
|
||
### Via NPM | ||
|
||
You can install Resize from NPM for use inside your bundle like so: | ||
|
||
```shell | ||
npm install @alpinejs/resize | ||
``` | ||
|
||
Then initialize it from your bundle: | ||
|
||
```js | ||
import Alpine from 'alpinejs' | ||
import resize from '@alpinejs/resize' | ||
|
||
Alpine.plugin(resize) | ||
|
||
... | ||
``` | ||
|
||
<a name="x-resize"></a> | ||
## x-resize | ||
|
||
The primary API for using this plugin is `x-resize`. You can add `x-resize` to any element within an Alpine component, and when that element is resized for any reason, the provided expression will execute with two magic properties: `$width` and `$height`. | ||
|
||
For example, here's a simple example of using `x-resize` do display the width and height of an element as it changes size. | ||
|
||
```alpine | ||
<div | ||
x-data="{ width: 0, height: 0 }" | ||
x-resize="width = $width; height = $height" | ||
> | ||
<p x-text="'Width: ' + width + 'px'"></p> | ||
<p x-text="'Height: ' + height + 'px'"></p> | ||
</div> | ||
``` | ||
|
||
<!-- START_VERBATIM --> | ||
<div class="demo"> | ||
<div x-data="{ width: 0, height: 0 }" x-resize="width = $width; height = $height"> | ||
<i>Resize your browser window to see the width and height values change.</i> | ||
<br><br> | ||
<p x-text="'Width: ' + width + 'px'"></p> | ||
<p x-text="'Height: ' + height + 'px'"></p> | ||
</div> | ||
</div> | ||
<!-- END_VERBATIM --> | ||
|
||
<a name="modifiers"></a> | ||
## Modifiers | ||
|
||
<a name="document"></a> | ||
### .document | ||
|
||
It's often useful to observer the entire document's size, rather than a specific element. To do this, you can add the `.document` modifier to `x-resize`: | ||
|
||
```alpine | ||
<div x-resize.document="..."> | ||
``` | ||
|
||
<!-- START_VERBATIM --> | ||
<div class="demo"> | ||
<div x-data="{ width: 0, height: 0 }" x-resize.document="width = $width; height = $height"> | ||
<i>Resize your browser window to see the document width and height values change.</i> | ||
<br><br> | ||
<p x-text="'Width: ' + width + 'px'"></p> | ||
<p x-text="'Height: ' + height + 'px'"></p> | ||
</div> | ||
</div> | ||
<!-- END_VERBATIM --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters