javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(): add iOS only note to translucent props (#18529)

Browse Source 
* docs(): add ios-only note to translucency

* change wording slightly

* update ios only verbiage
This commit is contained in:
Liam DeBeasi
2019-06-13 16:04:40 -04:00
committed by GitHub
parent eb9bad7a31
commit 7f1829eb21
5 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/src/components.d.ts vendored
View File

@@ -1634,7 +1634,7 @@ export namespace Components {
*/
'mode': Mode;
/**
* If `true`, the footer will be translucent. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content.
* If `true`, the footer will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content.
*/
'translucent': boolean;
}
@@ -1644,7 +1644,7 @@ export namespace Components {
*/
'mode'?: Mode;
/**
* If `true`, the footer will be translucent. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content.
* If `true`, the footer will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content.
*/
'translucent'?: boolean;
}
@@ -1668,7 +1668,7 @@ export namespace Components {
*/
'mode': Mode;
/**
* If `true`, the header will be translucent. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content.
* If `true`, the header will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content.
*/
'translucent': boolean;
}
@@ -1678,7 +1678,7 @@ export namespace Components {
*/
'mode'?: Mode;
/**
* If `true`, the header will be translucent. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content.
* If `true`, the header will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content.
*/
'translucent'?: boolean;
}

2
core/src/components/footer/footer.tsx
View File

@@ -17,7 +17,7 @@ export class Footer implements ComponentInterface {
@Prop() mode!: Mode;
/**
* If `true`, the footer will be translucent.
* If `true`, the footer will be translucent. Only applies to `ios` mode.
* Note: In order to scroll content behind the footer, the `fullscreen`
* attribute needs to be set on the content.
*/

8
core/src/components/footer/readme.md
View File

@@ -47,10 +47,10 @@ export default Example;
## Properties
| Property | Attribute | Description | Type | Default |
| ------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------- |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `translucent` | `translucent` | If `true`, the footer will be translucent. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------- |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `translucent` | `translucent` | If `true`, the footer will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the footer, the `fullscreen` attribute needs to be set on the content. | `boolean` | `false` |
----------------------------------------------

2
core/src/components/header/header.tsx
View File

@@ -17,7 +17,7 @@ export class Header implements ComponentInterface {
@Prop() mode!: Mode;
/**
* If `true`, the header will be translucent.
* If `true`, the header will be translucent. Only applies to `ios` mode.
* Note: In order to scroll content behind the header, the `fullscreen`
* attribute needs to be set on the content.
*/

8
core/src/components/header/readme.md
View File

@@ -62,10 +62,10 @@ export default Example
## Properties
| Property | Attribute | Description | Type | Default |
| ------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------- |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `translucent` | `translucent` | If `true`, the header will be translucent. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | ----------- |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `translucent` | `translucent` | If `true`, the header will be translucent. Only applies to `ios` mode. Note: In order to scroll content behind the header, the `fullscreen` attribute needs to be set on the content. | `boolean` | `false` |
----------------------------------------------