From aac60b139061f2d88130bf828f6ff479cb90d0a9 Mon Sep 17 00:00:00 2001 From: Liam DeBeasi Date: Tue, 11 Jun 2019 14:01:12 -0400 Subject: [PATCH] default to never --- core/api.txt | 2 +- core/src/components.d.ts | 4 ++-- core/src/components/searchbar/readme.md | 2 +- core/src/components/searchbar/searchbar.tsx | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/core/api.txt b/core/api.txt index af05e91e96..421dbe22d8 100644 --- a/core/api.txt +++ b/core/api.txt @@ -917,7 +917,7 @@ ion-searchbar,prop,disabled,boolean,false,false,false ion-searchbar,prop,mode,"ios" | "md",undefined,false,false ion-searchbar,prop,placeholder,string,'Search',false,false ion-searchbar,prop,searchIcon,string,'search',false,false -ion-searchbar,prop,showCancelButton,boolean | string,false,false,false +ion-searchbar,prop,showCancelButton,boolean | string,'never',false,false ion-searchbar,prop,spellcheck,boolean,false,false,false ion-searchbar,prop,type,"email" | "number" | "password" | "search" | "tel" | "text" | "url",'search',false,false ion-searchbar,prop,value,null | string | undefined,'',false,false diff --git a/core/src/components.d.ts b/core/src/components.d.ts index f0480cbd89..ecb5ac7c3e 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -3800,7 +3800,7 @@ export namespace Components { */ 'setFocus': () => void; /** - * Sets the behavior for the cancel button. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. + * Sets the behavior for the cancel button. Defaults to `"never"`. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. */ 'showCancelButton': boolean | string; /** @@ -3890,7 +3890,7 @@ export namespace Components { */ 'searchIcon'?: string; /** - * Sets the behavior for the cancel button. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. + * Sets the behavior for the cancel button. Defaults to `"never"`. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. */ 'showCancelButton'?: boolean | string; /** diff --git a/core/src/components/searchbar/readme.md b/core/src/components/searchbar/readme.md index 5edb1ff281..79e12c5f2a 100644 --- a/core/src/components/searchbar/readme.md +++ b/core/src/components/searchbar/readme.md @@ -224,7 +224,7 @@ export default Example; | `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` | | `placeholder` | `placeholder` | Set the input's placeholder. `placeholder` can accept either plaintext or HTML as a string. To display characters normally reserved for HTML, they must be escaped. For example `` would become `<Ionic>` For more information: [Security Documentation](https://ionicframework.com/docs/faq/security) | `string` | `'Search'` | | `searchIcon` | `search-icon` | The icon to use as the search icon. | `string` | `'search'` | -| `showCancelButton` | `show-cancel-button` | Sets the behavior for the cancel button. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. | `boolean \| string` | `false` | +| `showCancelButton` | `show-cancel-button` | Sets the behavior for the cancel button. Defaults to `"never"`. Setting to `"focus"` shows the cancel button on focus. Setting to `"never"` hides the cancel button. Setting to `"always"` shows the cancel button regardless of focus state. | `boolean \| string` | `'never'` | | `spellcheck` | `spellcheck` | If `true`, enable spellcheck on the input. | `boolean` | `false` | | `type` | `type` | Set the type of the input. | `"email" \| "number" \| "password" \| "search" \| "tel" \| "text" \| "url"` | `'search'` | | `value` | `value` | the value of the searchbar. | `null \| string \| undefined` | `''` | diff --git a/core/src/components/searchbar/searchbar.tsx b/core/src/components/searchbar/searchbar.tsx index 761918eb31..2667519e0e 100644 --- a/core/src/components/searchbar/searchbar.tsx +++ b/core/src/components/searchbar/searchbar.tsx @@ -103,13 +103,13 @@ export class Searchbar implements ComponentInterface { @Prop() searchIcon = 'search'; /** - * Sets the behavior for the cancel button. + * Sets the behavior for the cancel button. Defaults to `"never"`. * Setting to `"focus"` shows the cancel button on focus. * Setting to `"never"` hides the cancel button. * Setting to `"always"` shows the cancel button regardless * of focus state. */ - @Prop() showCancelButton: boolean | string = false; + @Prop() showCancelButton: boolean | string = 'never'; /** * If `true`, enable spellcheck on the input.