mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-11-10 00:27:41 +08:00
chore(): update to latest stencil
This commit is contained in:
Manu Mtz.-Almeida
@ -9,140 +9,34 @@ view component.
|
||||
|
||||
## Properties
|
||||
|
||||
#### color
|
||||
|
||||
string
|
||||
|
||||
|
||||
#### forceOverscroll
|
||||
|
||||
boolean
|
||||
|
||||
If true and the content does not cause an overflow scroll, the scroll interaction will cause a bounce.
|
||||
If the content exceeds the bounds of ionContent, nothing will change.
|
||||
Note, the does not disable the system bounce on iOS. That is an OS level setting.
|
||||
|
||||
|
||||
#### fullscreen
|
||||
|
||||
boolean
|
||||
|
||||
If true, the content will scroll behind the headers
|
||||
and footers. This effect can easily be seen by setting the toolbar
|
||||
to transparent.
|
||||
|
||||
|
||||
#### scrollEvents
|
||||
|
||||
boolean
|
||||
|
||||
Because of performance reasons, ionScroll events are disabled by default, in order to enable them
|
||||
and start listening from (ionScroll), set this property to `true`.
|
||||
|
||||
|
||||
#### scrollX
|
||||
|
||||
boolean
|
||||
|
||||
If you want to enable the content scrolling in the X axis, set this property to `true`.
|
||||
|
||||
|
||||
#### scrollY
|
||||
|
||||
boolean
|
||||
|
||||
If you want to disable the content scrolling in the Y axis, set this property to `false`.
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
#### color
|
||||
|
||||
string
|
||||
|
||||
|
||||
#### force-overscroll
|
||||
|
||||
boolean
|
||||
|
||||
If true and the content does not cause an overflow scroll, the scroll interaction will cause a bounce.
|
||||
If the content exceeds the bounds of ionContent, nothing will change.
|
||||
Note, the does not disable the system bounce on iOS. That is an OS level setting.
|
||||
|
||||
|
||||
#### fullscreen
|
||||
|
||||
boolean
|
||||
|
||||
If true, the content will scroll behind the headers
|
||||
and footers. This effect can easily be seen by setting the toolbar
|
||||
to transparent.
|
||||
|
||||
|
||||
#### scroll-events
|
||||
|
||||
boolean
|
||||
|
||||
Because of performance reasons, ionScroll events are disabled by default, in order to enable them
|
||||
and start listening from (ionScroll), set this property to `true`.
|
||||
|
||||
|
||||
#### scroll-x
|
||||
|
||||
boolean
|
||||
|
||||
If you want to enable the content scrolling in the X axis, set this property to `true`.
|
||||
|
||||
|
||||
#### scroll-y
|
||||
|
||||
boolean
|
||||
|
||||
If you want to disable the content scrolling in the Y axis, set this property to `false`.
|
||||
| Property | Attribute | Description | Type |
|
||||
| ----------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
|
||||
| `color` | `color` | | `Color` |
|
||||
| `forceOverscroll` | `force-overscroll` | If true and the content does not cause an overflow scroll, the scroll interaction will cause a bounce. If the content exceeds the bounds of ionContent, nothing will change. Note, the does not disable the system bounce on iOS. That is an OS level setting. | `boolean` |
|
||||
| `fullscreen` | `fullscreen` | If true, the content will scroll behind the headers and footers. This effect can easily be seen by setting the toolbar to transparent. | `boolean` |
|
||||
| `scrollEvents` | `scroll-events` | Because of performance reasons, ionScroll events are disabled by default, in order to enable them and start listening from (ionScroll), set this property to `true`. | `boolean` |
|
||||
| `scrollX` | `scroll-x` | If you want to enable the content scrolling in the X axis, set this property to `true`. | `boolean` |
|
||||
| `scrollY` | `scroll-y` | If you want to disable the content scrolling in the Y axis, set this property to `false`. | `boolean` |
|
||||
|
||||
|
||||
## Events
|
||||
|
||||
#### ionScroll
|
||||
|
||||
Emitted while scrolling. This event is disabled by default.
|
||||
Look at the property: `scrollEvents`
|
||||
|
||||
|
||||
#### ionScrollEnd
|
||||
|
||||
Emitted when the scroll has ended.
|
||||
|
||||
|
||||
#### ionScrollStart
|
||||
|
||||
Emitted when the scroll has started.
|
||||
| Event | Description |
|
||||
| ---------------- | ------------------------------------------------------------------------------------------------ |
|
||||
| `ionScroll` | Emitted while scrolling. This event is disabled by default. Look at the property: `scrollEvents` |
|
||||
| `ionScrollEnd` | Emitted when the scroll has ended. |
|
||||
| `ionScrollStart` | Emitted when the scroll has started. |
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
#### getScrollElement()
|
||||
|
||||
|
||||
#### scrollByPoint()
|
||||
|
||||
Scroll by a specified X/Y distance in the component
|
||||
|
||||
|
||||
#### scrollToBottom()
|
||||
|
||||
Scroll to the bottom of the component
|
||||
|
||||
|
||||
#### scrollToPoint()
|
||||
|
||||
Scroll to a specified X/Y location in the component
|
||||
|
||||
|
||||
#### scrollToTop()
|
||||
|
||||
Scroll to the top of the component
|
||||
|
||||
| Method | Description |
|
||||
| ------------------ | --------------------------------------------------- |
|
||||
| `getScrollElement` | |
|
||||
| `scrollByPoint` | Scroll by a specified X/Y distance in the component |
|
||||
| `scrollToBottom` | Scroll to the bottom of the component |
|
||||
| `scrollToPoint` | Scroll to a specified X/Y location in the component |
|
||||
| `scrollToTop` | Scroll to the top of the component |
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user