docs(config): update innerHTML comments (#27032)

This commit is contained in:
Liam DeBeasi
2023-03-27 15:14:02 -04:00
committed by GitHub
parent ae482823e5
commit 5c0ead37bf
7 changed files with 33 additions and 33 deletions

View File

@ -272,7 +272,7 @@ export namespace Components {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* The main message to be displayed in the alert. `message` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The main message to be displayed in the alert. `message` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**
@ -1135,7 +1135,7 @@ export namespace Components {
*/ */
"loadingSpinner"?: SpinnerTypes | null; "loadingSpinner"?: SpinnerTypes | null;
/** /**
* Optional text to display while loading. `loadingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Optional text to display while loading. `loadingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"loadingText"?: string | IonicSafeString; "loadingText"?: string | IonicSafeString;
} }
@ -1554,7 +1554,7 @@ export namespace Components {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* Optional text content to display in the loading indicator. This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Optional text content to display in the loading indicator. This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**
@ -2382,7 +2382,7 @@ export namespace Components {
*/ */
"pullingIcon"?: SpinnerTypes | string | null; "pullingIcon"?: SpinnerTypes | string | null;
/** /**
* The text you want to display when you begin to pull down. `pullingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The text you want to display when you begin to pull down. `pullingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"pullingText"?: string | IonicSafeString; "pullingText"?: string | IonicSafeString;
/** /**
@ -2390,7 +2390,7 @@ export namespace Components {
*/ */
"refreshingSpinner"?: SpinnerTypes | null; "refreshingSpinner"?: SpinnerTypes | null;
/** /**
* The text you want to display when performing a refresh. `refreshingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The text you want to display when performing a refresh. `refreshingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"refreshingText"?: string | IonicSafeString; "refreshingText"?: string | IonicSafeString;
} }
@ -3118,7 +3118,7 @@ export namespace Components {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* Message to be shown in the toast. This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Message to be shown in the toast. This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**
@ -4235,7 +4235,7 @@ declare namespace LocalJSX {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* The main message to be displayed in the alert. `message` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The main message to be displayed in the alert. `message` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**
@ -5169,7 +5169,7 @@ declare namespace LocalJSX {
*/ */
"loadingSpinner"?: SpinnerTypes | null; "loadingSpinner"?: SpinnerTypes | null;
/** /**
* Optional text to display while loading. `loadingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Optional text to display while loading. `loadingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"loadingText"?: string | IonicSafeString; "loadingText"?: string | IonicSafeString;
} }
@ -5584,7 +5584,7 @@ declare namespace LocalJSX {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* Optional text content to display in the loading indicator. This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Optional text content to display in the loading indicator. This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**
@ -6421,7 +6421,7 @@ declare namespace LocalJSX {
*/ */
"pullingIcon"?: SpinnerTypes | string | null; "pullingIcon"?: SpinnerTypes | string | null;
/** /**
* The text you want to display when you begin to pull down. `pullingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The text you want to display when you begin to pull down. `pullingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"pullingText"?: string | IonicSafeString; "pullingText"?: string | IonicSafeString;
/** /**
@ -6429,7 +6429,7 @@ declare namespace LocalJSX {
*/ */
"refreshingSpinner"?: SpinnerTypes | null; "refreshingSpinner"?: SpinnerTypes | null;
/** /**
* The text you want to display when performing a refresh. `refreshingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * The text you want to display when performing a refresh. `refreshingText` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `<Ionic>` would become `&lt;Ionic&gt;` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"refreshingText"?: string | IonicSafeString; "refreshingText"?: string | IonicSafeString;
} }
@ -7214,7 +7214,7 @@ declare namespace LocalJSX {
*/ */
"leaveAnimation"?: AnimationBuilder; "leaveAnimation"?: AnimationBuilder;
/** /**
* Message to be shown in the toast. This property accepts custom HTML as a string. Developers who only want to pass plain text can disable the custom HTML functionality by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * Message to be shown in the toast. This property accepts custom HTML as a string. Content is parsed as plaintext by default. `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config before custom HTML can be used.
*/ */
"message"?: string | IonicSafeString; "message"?: string | IonicSafeString;
/** /**

View File

@ -109,9 +109,9 @@ export class Alert implements ComponentInterface, OverlayInterface {
* For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) * For more information: [Security Documentation](https://ionicframework.com/docs/faq/security)
* *
* This property accepts custom HTML as a string. * This property accepts custom HTML as a string.
* Developers who only want to pass plain text * Content is parsed as plaintext by default.
* can disable the custom HTML functionality * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * before custom HTML can be used.
*/ */
@Prop() message?: string | IonicSafeString; @Prop() message?: string | IonicSafeString;

View File

@ -33,9 +33,9 @@ export class InfiniteScrollContent implements ComponentInterface {
* For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) * For more information: [Security Documentation](https://ionicframework.com/docs/faq/security)
* *
* This property accepts custom HTML as a string. * This property accepts custom HTML as a string.
* Developers who only want to pass plain text * Content is parsed as plaintext by default.
* can disable the custom HTML functionality * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * before custom HTML can be used.
*/ */
@Prop() loadingText?: string | IonicSafeString; @Prop() loadingText?: string | IonicSafeString;

View File

@ -79,9 +79,9 @@ export class Loading implements ComponentInterface, OverlayInterface {
* Optional text content to display in the loading indicator. * Optional text content to display in the loading indicator.
* *
* This property accepts custom HTML as a string. * This property accepts custom HTML as a string.
* Developers who only want to pass plain text * Content is parsed as plaintext by default.
* can disable the custom HTML functionality * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * before custom HTML can be used.
*/ */
@Prop() message?: string | IonicSafeString; @Prop() message?: string | IonicSafeString;

View File

@ -35,10 +35,9 @@ export class RefresherContent implements ComponentInterface {
* *
* For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) * For more information: [Security Documentation](https://ionicframework.com/docs/faq/security)
* *
* This property accepts custom HTML as a string. * Content is parsed as plaintext by default.
* Developers who only want to pass plain text * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* can disable the custom HTML functionality * before custom HTML can be used.
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config.
*/ */
@Prop() pullingText?: string | IonicSafeString; @Prop() pullingText?: string | IonicSafeString;
@ -56,10 +55,9 @@ export class RefresherContent implements ComponentInterface {
* *
* For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) * For more information: [Security Documentation](https://ionicframework.com/docs/faq/security)
* *
* This property accepts custom HTML as a string. * Content is parsed as plaintext by default.
* Developers who only want to pass plain text * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* can disable the custom HTML functionality * before custom HTML can be used.
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config.
*/ */
@Prop() refreshingText?: string | IonicSafeString; @Prop() refreshingText?: string | IonicSafeString;

View File

@ -114,9 +114,9 @@ export class Toast implements ComponentInterface, OverlayInterface {
/** /**
* Message to be shown in the toast. * Message to be shown in the toast.
* This property accepts custom HTML as a string. * This property accepts custom HTML as a string.
* Developers who only want to pass plain text * Content is parsed as plaintext by default.
* can disable the custom HTML functionality * `innerHTMLTemplatesEnabled` must be set to `true` in the Ionic config
* by setting `innerHTMLTemplatesEnabled: false` in the Ionic config. * before custom HTML can be used.
*/ */
@Prop() message?: string | IonicSafeString; @Prop() message?: string | IonicSafeString;

View File

@ -193,7 +193,9 @@ export interface IonicConfig {
* Relevant Components: ion-alert, ion-infinite-scroll-content, ion-loading, ion-refresher-content, ion-toast * Relevant Components: ion-alert, ion-infinite-scroll-content, ion-loading, ion-refresher-content, ion-toast
* If `false`, all `innerHTML` usage will be disabled in Ionic, and * If `false`, all `innerHTML` usage will be disabled in Ionic, and
* custom HTML will not be usable in the relevant components. * custom HTML will not be usable in the relevant components.
* `innerHTML` usage is enabled by default. * If `true`, all `innerHTML` usage will be enabled in Ionic, and
* custom HTML will be usable in the relevant components.
* `innerHTML` usage is disabled by default.
*/ */
innerHTMLTemplatesEnabled?: boolean; innerHTMLTemplatesEnabled?: boolean;