mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-18 19:21:34 +08:00
chore(): update to latest stencil
This commit is contained in:
Manu Mtz.-Almeida
@ -183,232 +183,29 @@ dataset, so please make sure they're performant.
|
||||
|
||||
## Properties
|
||||
|
||||
#### approxFooterHeight
|
||||
|
||||
number
|
||||
|
||||
The approximate width of each footer template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This value can use either `px` or `%` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is `100%`.
|
||||
|
||||
|
||||
#### approxHeaderHeight
|
||||
|
||||
number
|
||||
|
||||
The approximate height of each header template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This height value can only use `px` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is `40px`.
|
||||
|
||||
|
||||
#### approxItemHeight
|
||||
|
||||
number
|
||||
|
||||
It is important to provide this
|
||||
if virtual item height will be significantly larger than the default
|
||||
The approximate height of each virtual item template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This height value can only use `px` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is
|
||||
`45`.
|
||||
|
||||
|
||||
#### domRender
|
||||
|
||||
DomRenderFn
|
||||
|
||||
|
||||
#### footerFn
|
||||
|
||||
HeaderFn
|
||||
|
||||
Section footers and the data used within its given
|
||||
template can be dynamically created by passing a function to `footerFn`.
|
||||
The logic within the footer function can decide if the footer template
|
||||
should be used, and what data to give to the footer template. The function
|
||||
must return `null` if a footer cell shouldn't be created.
|
||||
|
||||
|
||||
#### headerFn
|
||||
|
||||
HeaderFn
|
||||
|
||||
Section headers and the data used within its given
|
||||
template can be dynamically created by passing a function to `headerFn`.
|
||||
For example, a large list of contacts usually has dividers between each
|
||||
letter in the alphabet. App's can provide their own custom `headerFn`
|
||||
which is called with each record within the dataset. The logic within
|
||||
the header function can decide if the header template should be used,
|
||||
and what data to give to the header template. The function must return
|
||||
`null` if a header cell shouldn't be created.
|
||||
|
||||
|
||||
#### itemHeight
|
||||
|
||||
ItemHeightFn
|
||||
|
||||
|
||||
#### items
|
||||
|
||||
any[]
|
||||
|
||||
The data that builds the templates within the virtual scroll.
|
||||
It's important to note that when this data has changed, then the
|
||||
entire virtual scroll is reset, which is an expensive operation and
|
||||
should be avoided if possible.
|
||||
|
||||
|
||||
#### nodeRender
|
||||
|
||||
ItemRenderFn
|
||||
|
||||
|
||||
#### renderFooter
|
||||
|
||||
(item: any, index: number) => JSX.Element
|
||||
|
||||
|
||||
#### renderHeader
|
||||
|
||||
(item: any, index: number) => JSX.Element
|
||||
|
||||
|
||||
#### renderItem
|
||||
|
||||
(item: any, index: number) => JSX.Element
|
||||
|
||||
|
||||
## Attributes
|
||||
|
||||
#### approx-footer-height
|
||||
|
||||
number
|
||||
|
||||
The approximate width of each footer template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This value can use either `px` or `%` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is `100%`.
|
||||
|
||||
|
||||
#### approx-header-height
|
||||
|
||||
number
|
||||
|
||||
The approximate height of each header template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This height value can only use `px` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is `40px`.
|
||||
|
||||
|
||||
#### approx-item-height
|
||||
|
||||
number
|
||||
|
||||
It is important to provide this
|
||||
if virtual item height will be significantly larger than the default
|
||||
The approximate height of each virtual item template's cell.
|
||||
This dimension is used to help determine how many cells should
|
||||
be created when initialized, and to help calculate the height of
|
||||
the scrollable area. This height value can only use `px` units.
|
||||
Note that the actual rendered size of each cell comes from the
|
||||
app's CSS, whereas this approximation is used to help calculate
|
||||
initial dimensions before the item has been rendered. Default is
|
||||
`45`.
|
||||
|
||||
|
||||
#### dom-render
|
||||
|
||||
|
||||
|
||||
|
||||
#### footer-fn
|
||||
|
||||
|
||||
|
||||
Section footers and the data used within its given
|
||||
template can be dynamically created by passing a function to `footerFn`.
|
||||
The logic within the footer function can decide if the footer template
|
||||
should be used, and what data to give to the footer template. The function
|
||||
must return `null` if a footer cell shouldn't be created.
|
||||
|
||||
|
||||
#### header-fn
|
||||
|
||||
|
||||
|
||||
Section headers and the data used within its given
|
||||
template can be dynamically created by passing a function to `headerFn`.
|
||||
For example, a large list of contacts usually has dividers between each
|
||||
letter in the alphabet. App's can provide their own custom `headerFn`
|
||||
which is called with each record within the dataset. The logic within
|
||||
the header function can decide if the header template should be used,
|
||||
and what data to give to the header template. The function must return
|
||||
`null` if a header cell shouldn't be created.
|
||||
|
||||
|
||||
#### item-height
|
||||
|
||||
|
||||
|
||||
|
||||
#### items
|
||||
|
||||
|
||||
|
||||
The data that builds the templates within the virtual scroll.
|
||||
It's important to note that when this data has changed, then the
|
||||
entire virtual scroll is reset, which is an expensive operation and
|
||||
should be avoided if possible.
|
||||
|
||||
|
||||
#### node-render
|
||||
|
||||
|
||||
|
||||
|
||||
#### render-footer
|
||||
|
||||
|
||||
|
||||
|
||||
#### render-header
|
||||
|
||||
|
||||
|
||||
|
||||
#### render-item
|
||||
|
||||
|
||||
| Property | Attribute | Description | Type |
|
||||
| -------------------- | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
|
||||
| `approxFooterHeight` | `approx-footer-height` | The approximate width of each footer template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This value can use either `px` or `%` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `100%`. | `number` |
|
||||
| `approxHeaderHeight` | `approx-header-height` | The approximate height of each header template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `40px`. | `number` |
|
||||
| `approxItemHeight` | `approx-item-height` | It is important to provide this if virtual item height will be significantly larger than the default The approximate height of each virtual item template's cell. This dimension is used to help determine how many cells should be created when initialized, and to help calculate the height of the scrollable area. This height value can only use `px` units. Note that the actual rendered size of each cell comes from the app's CSS, whereas this approximation is used to help calculate initial dimensions before the item has been rendered. Default is `45`. | `number` |
|
||||
| `domRender` | -- | | `DomRenderFn` |
|
||||
| `footerFn` | -- | Section footers and the data used within its given template can be dynamically created by passing a function to `footerFn`. The logic within the footer function can decide if the footer template should be used, and what data to give to the footer template. The function must return `null` if a footer cell shouldn't be created. | `HeaderFn` |
|
||||
| `headerFn` | -- | Section headers and the data used within its given template can be dynamically created by passing a function to `headerFn`. For example, a large list of contacts usually has dividers between each letter in the alphabet. App's can provide their own custom `headerFn` which is called with each record within the dataset. The logic within the header function can decide if the header template should be used, and what data to give to the header template. The function must return `null` if a header cell shouldn't be created. | `HeaderFn` |
|
||||
| `itemHeight` | -- | | `ItemHeightFn` |
|
||||
| `items` | -- | The data that builds the templates within the virtual scroll. It's important to note that when this data has changed, then the entire virtual scroll is reset, which is an expensive operation and should be avoided if possible. | `any[]` |
|
||||
| `nodeRender` | -- | | `ItemRenderFn` |
|
||||
| `renderFooter` | -- | | `(item: any, index: number) => JSX.Element` |
|
||||
| `renderHeader` | -- | | `(item: any, index: number) => JSX.Element` |
|
||||
| `renderItem` | -- | | `(item: any, index: number) => JSX.Element` |
|
||||
|
||||
|
||||
## Methods
|
||||
|
||||
#### markDirty()
|
||||
|
||||
|
||||
#### markDirtyTail()
|
||||
|
||||
|
||||
#### positionForItem()
|
||||
|
||||
| Method | Description |
|
||||
| ----------------- | ----------- |
|
||||
| `markDirty` | |
|
||||
| `markDirtyTail` | |
|
||||
| `positionForItem` | |
|
||||
|
||||
|
||||
----------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user