javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-10 00:27:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(all): possible values are extracted by stencil (#16190)

Browse Source 
* docs(all): possible values are extracted by stencil

* add defaults

* remove all hardcoded defaults

* update stencil
This commit is contained in:
Manu MA
2018-11-02 00:06:40 +01:00
committed by GitHub
parent 335acf96ee
commit ecc2c55370
151 changed files with 1363 additions and 1430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
core/src/components/refresher/readme.md
View File

@ -15,22 +15,22 @@ refresher.
## Properties
| Property | Attribute | Description | Type |
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `closeDuration` | `close-duration` | Time it takes to close the refresher. Defaults to `280ms`. | `string` |
| `disabled` | `disabled` | If `true`, the refresher will be hidden. Defaults to `false`. | `boolean` |
| `pullMax` | `pull-max` | The maximum distance of the pull until the refresher will automatically go into the `refreshing` state. Defaults to the result of `pullMin + 60`. | `number` |
| `pullMin` | `pull-min` | The minimum distance the user must pull down until the refresher will go into the `refreshing` state. Defaults to `60`. | `number` |
| `snapbackDuration` | `snapback-duration` | Time it takes the refresher to to snap back to the `refreshing` state. Defaults to `280ms`. | `string` |
| Property | Attribute | Description | Type | Default |
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------------- |
| `closeDuration` | `close-duration` | Time it takes to close the refresher. | `string` | `'280ms'` |
| `disabled` | `disabled` | If `true`, the refresher will be hidden. | `boolean` | `false` |
| `pullMax` | `pull-max` | The maximum distance of the pull until the refresher will automatically go into the `refreshing` state. Defaults to the result of `pullMin + 60`. | `number` | `this.pullMin + 60` |
| `pullMin` | `pull-min` | The minimum distance the user must pull down until the refresher will go into the `refreshing` state. | `number` | `60` |
| `snapbackDuration` | `snapback-duration` | Time it takes the refresher to to snap back to the `refreshing` state. | `string` | `'280ms'` |
## Events
| Event | Detail | Description |
| ------------ | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ionPull` | | Emitted while the user is pulling down the content and exposing the refresher. |
| `ionRefresh` | RefresherEventDetail | Emitted when the user lets go of the content and has pulled down further than the `pullMin` or pulls the content down and exceeds the pullMax. Updates the refresher state to `refreshing`. The `complete()` method should be called when the async operation has completed. |
| `ionStart` | | Emitted when the user begins to start pulling down. |
| Event | Description | Detail |
| ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `ionPull` | Emitted while the user is pulling down the content and exposing the refresher. | void |
| `ionRefresh` | Emitted when the user lets go of the content and has pulled down further than the `pullMin` or pulls the content down and exceeds the pullMax. Updates the refresher state to `refreshing`. The `complete()` method should be called when the async operation has completed. | RefresherEventDetail |
| `ionStart` | Emitted when the user begins to start pulling down. | void |
## Methods

8
core/src/components/refresher/refresher.tsx
View File

@ -38,7 +38,7 @@ export class Refresher implements ComponentInterface {
/**
* The minimum distance the user must pull down until the
* refresher will go into the `refreshing` state. Defaults to `60`.
* refresher will go into the `refreshing` state.
*/
@Prop() pullMin = 60;
@ -51,17 +51,17 @@ export class Refresher implements ComponentInterface {
// TODO: NEVER USED
/**
* Time it takes to close the refresher. Defaults to `280ms`.
* Time it takes to close the refresher.
*/
@Prop() closeDuration = '280ms';
/**
* Time it takes the refresher to to snap back to the `refreshing` state. Defaults to `280ms`.
* Time it takes the refresher to to snap back to the `refreshing` state.
*/
@Prop() snapbackDuration = '280ms';
/**
* If `true`, the refresher will be hidden. Defaults to `false`.
* If `true`, the refresher will be hidden.
*/
@Prop() disabled = false;
@Watch('disabled')