packaged-ui / pagelets
Installs: 16 153
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 3
Forks: 1
Open Issues: 2
Language:JavaScript
Requires
- php: >=7.1
- ext-json: *
Requires (Dev)
- cubex/framework: ^4.3
- packaged/dispatch: ^2.10
- packaged/glimpse: ^2.7
- phpunit/phpunit: ^6.0
- dev-master
- 2.6.0
- 2.5.0
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.11
- 2.3.10
- 2.3.9
- 2.3.8
- 2.3.7
- 2.3.6
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.1
- 2.2.0
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.8.1
- 1.8.0
- 1.7.1
- 1.7.0
- 1.6.2
- 1.6.1
- 1.6.0
- 1.5.2
- 1.5.1
- 1.5.0
- 1.4.3
- 1.4.2
- 1.4.1
- 1.4.0
- 1.3.1
- 1.3.0
- 1.2.0
- 1.1.2
- 1.1.1
- 1.1.0
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.6.0
- 0.5.2
- 0.5.1
- 0.5.0
- 0.4.1
- 0.4.0
- 0.3.4
- 0.3.3
- 0.3.2
- 0.3.1
- 0.3.0
- 0.2.0
- 0.1.0
- 0.0.6
- dev-iterate_existing_responses
- dev-shadow-targets
This package is auto-updated.
Last update: 2025-02-25 12:57:37 UTC
README
Usage
Initialize
Initialize pagelet events (link clicks and form submissions)
Pagelets.init(options);
Options
| Property | Type | Default | Description |
|---|---|---|---|
| selector | string | a[data-uri],button[data-uri],[href][data-target] |
Which "click" event elements to react to |
| formSelector | string | form[data-uri],form[data-target] |
Which "submit" event elements to react to |
| defaultTarget | string | document.body |
If no data-target specified, which container to load the content into |
| allowPersistentTargets | boolean | true |
If a page has been reloaded, allow pagelets to load into containers of the same name |
| listenElement | Node | document |
Listen to links within this container only |
| minRefreshRate | int | 500 |
Minimum time to wait between pagelet refreshes |
| iterator | ActionIterator | new ActionIterator() |
set the default iterator |
Manual request
Manually make pagelet request
const req = new Pagelets.Request(options); Pagelets.load(req) .then(({request, response}) => { // process response (if necessary) }) .catch((e) => { // error handling });
Pagelet Options
| Property | Type | Default | Description |
|---|---|---|---|
| url [required] | String | URL of the resource to request | |
| iterator | ActionIterator | uses global options | action iterator to use when processing the response |
| sourceElement | Element | element requesting the pagelet | |
| targetElement | Element/String | element to receive the default pagelet content | |
| pushUrl | String | URL to set in the address bar | |
| headers | Object | object containing custom headers for the request | |
| data | Object | object containing post data | |
| method | String | request method to use | |
| withCredentials | Boolean | false |
set withCredentials |