Repository navigation
feat(title): add recipe and tokens #31539
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2811,12 +2811,57 @@ ion-thumbnail,css-prop,--ion-thumbnail-width | |
|
|
||
| ion-title,shadow | ||
| ion-title,prop,color,"danger" | "dark" | "light" | "medium" | "primary" | "secondary" | "success" | "tertiary" | "warning" | string & Record<never, never> | undefined,undefined,false,true | ||
| ion-title,prop,hue,"bold" | "subtle" | undefined,undefined,false,false | ||
| ion-title,prop,mode,"ios" | "md",undefined,false,false | ||
| ion-title,prop,size,"large" | "medium" | "small" | undefined,undefined,false,false | ||
| ion-title,css-prop,--ion-title-box-sizing | ||
| ion-title,css-prop,--ion-title-color | ||
| ion-title,css-prop,--ion-title-font-family | ||
| ion-title,css-prop,--ion-title-hue-bold-semantic-default-color | ||
| ion-title,css-prop,--ion-title-hue-subtle-semantic-default-color | ||
| ion-title,css-prop,--ion-title-letter-spacing | ||
| ion-title,css-prop,--ion-title-pointer-events | ||
| ion-title,css-prop,--ion-title-position-bottom | ||
| ion-title,css-prop,--ion-title-position-end | ||
| ion-title,css-prop,--ion-title-position-start | ||
| ion-title,css-prop,--ion-title-position-top | ||
| ion-title,css-prop,--ion-title-size-large-align-items | ||
| ion-title,css-prop,--ion-title-size-large-font-size | ||
| ion-title,css-prop,--ion-title-size-large-font-weight | ||
| ion-title,css-prop,--ion-title-size-large-height | ||
| ion-title,css-prop,--ion-title-size-large-inner-width | ||
| ion-title,css-prop,--ion-title-size-large-line-height | ||
| ion-title,css-prop,--ion-title-size-large-min-width | ||
| ion-title,css-prop,--ion-title-size-large-padding-bottom | ||
| ion-title,css-prop,--ion-title-size-large-padding-end | ||
| ion-title,css-prop,--ion-title-size-large-padding-start | ||
| ion-title,css-prop,--ion-title-size-large-padding-top | ||
| ion-title,css-prop,--ion-title-size-large-position | ||
| ion-title,css-prop,--ion-title-size-large-text-align | ||
| ion-title,css-prop,--ion-title-size-large-transform-origin-x | ||
| ion-title,css-prop,--ion-title-size-large-width | ||
| ion-title,css-prop,--ion-title-size-medium-font-size | ||
| ion-title,css-prop,--ion-title-size-medium-font-weight | ||
| ion-title,css-prop,--ion-title-size-medium-height | ||
| ion-title,css-prop,--ion-title-size-medium-line-height | ||
| ion-title,css-prop,--ion-title-size-medium-padding-bottom | ||
| ion-title,css-prop,--ion-title-size-medium-padding-end | ||
| ion-title,css-prop,--ion-title-size-medium-padding-start | ||
| ion-title,css-prop,--ion-title-size-medium-padding-top | ||
| ion-title,css-prop,--ion-title-size-medium-position | ||
| ion-title,css-prop,--ion-title-size-medium-text-align | ||
| ion-title,css-prop,--ion-title-size-medium-width | ||
| ion-title,css-prop,--ion-title-size-small-font-size | ||
| ion-title,css-prop,--ion-title-size-small-font-weight | ||
| ion-title,css-prop,--ion-title-size-small-height | ||
| ion-title,css-prop,--ion-title-size-small-line-height | ||
| ion-title,css-prop,--ion-title-size-small-padding-bottom | ||
| ion-title,css-prop,--ion-title-size-small-padding-end | ||
| ion-title,css-prop,--ion-title-size-small-padding-start | ||
| ion-title,css-prop,--ion-title-size-small-padding-top | ||
| ion-title,css-prop,--ion-title-size-small-position | ||
| ion-title,css-prop,--ion-title-size-small-text-align | ||
| ion-title,css-prop,--ion-title-size-small-width | ||
|
|
||
| ion-toast,shadow | ||
| ion-toast,prop,animated,boolean,true,false,false | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,6 +49,7 @@ import { SelectPopoverOption } from "./components/select-popover/select-popover- | |
| import { SpinnerSize } from "./components/spinner/spinner.interfaces"; | ||
| import { TabBarChangedEventDetail, TabBarScrollEffect, TabButtonClickEventDetail, TabButtonLayout } from "./components/tab-bar/tab-bar-interface"; | ||
| import { TextareaChangeEventDetail, TextareaInputEventDetail } from "./components/textarea/textarea-interface"; | ||
| import { IonTitleSize } from "./components/title/title.interface"; | ||
| import { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions, ToastSwipeGestureDirection } from "./components/toast/toast-interface"; | ||
| import { ToggleChangeEventDetail } from "./components/toggle/toggle-interface"; | ||
| export { AccordionGroupChangeEventDetail } from "./components/accordion-group/accordion-group-interface"; | ||
|
|
@@ -95,6 +96,7 @@ export { SelectPopoverOption } from "./components/select-popover/select-popover- | |
| export { SpinnerSize } from "./components/spinner/spinner.interfaces"; | ||
| export { TabBarChangedEventDetail, TabBarScrollEffect, TabButtonClickEventDetail, TabButtonLayout } from "./components/tab-bar/tab-bar-interface"; | ||
| export { TextareaChangeEventDetail, TextareaInputEventDetail } from "./components/textarea/textarea-interface"; | ||
| export { IonTitleSize } from "./components/title/title.interface"; | ||
| export { ToastButton, ToastDismissOptions, ToastLayout, ToastPosition, ToastPresentOptions, ToastSwipeGestureDirection } from "./components/toast/toast-interface"; | ||
| export { ToggleChangeEventDetail } from "./components/toggle/toggle-interface"; | ||
| export namespace Components { | ||
|
|
@@ -4172,17 +4174,17 @@ export namespace Components { | |
| */ | ||
| "color"?: Color; | ||
| /** | ||
| * Set to `"bold"` for a title with vibrant, bold colors or to `"subtle"` for a title with muted, subtle colors. Defaults to `"bold"` if both the hue property and theme config are unset. | ||
| */ | ||
| "hue"?: Hue; | ||
| /** | ||
| * The mode determines the platform behaviors of the component. | ||
| */ | ||
| "mode"?: "ios" | "md"; | ||
| /** | ||
| * The size of the toolbar title. Defaults to `"medium"` if both the size property and theme config are unset. | ||
| */ | ||
| "size"?: IonTitleSize; | ||
| } | ||
| interface IonToast { | ||
| /** | ||
|
|
@@ -10136,6 +10138,10 @@ declare namespace LocalJSX { | |
| * The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | ||
| */ | ||
| "color"?: Color; | ||
| /** | ||
| * Set to `"bold"` for a title with vibrant, bold colors or to `"subtle"` for a title with muted, subtle colors. Defaults to `"bold"` if both the hue property and theme config are unset. | ||
| */ | ||
| "hue"?: Hue; | ||
| /** | ||
| * The mode determines the platform behaviors of the component. | ||
| */ | ||
|
|
@@ -10145,13 +10151,9 @@ declare namespace LocalJSX { | |
| */ | ||
| "onIonStyle"?: (event: IonTitleCustomEvent<StyleEventDetail>) => void; | ||
| /** | ||
| * The size of the toolbar title. Defaults to `"medium"` if both the size property and theme config are unset. | ||
| */ | ||
| "size"?: IonTitleSize; | ||
| } | ||
| interface IonToast { | ||
| /** | ||
|
|
@@ -11146,7 +11148,8 @@ declare namespace LocalJSX { | |
| } | ||
| interface IonTitleAttributes { | ||
| "color": Color; | ||
| "hue": Hue; | ||
| "size": IonTitleSize; | ||
| } | ||
| interface IonToastAttributes { | ||
| "overlayIndex": number; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ import { | |
| handleContentScroll, | ||
| handleHeaderFade, | ||
| handleToolbarIntersection, | ||
| isLargeTitle, | ||
| setHeaderActive, | ||
| setToolbarBackgroundOpacity, | ||
| getRoleType, | ||
|
|
@@ -234,6 +235,10 @@ export class Header implements ComponentInterface { | |
| } | ||
| } | ||
|
|
||
| private hasLargeTitle() { | ||
| return Array.from(this.el.querySelectorAll('ion-title')).some(isLargeTitle); | ||
| } | ||
|
|
||
| private async setupCondenseHeader(contentEl: HTMLElement | null, pageEl: Element | null): Promise<boolean> { | ||
| if (!contentEl || !pageEl) { | ||
| printIonContentErrorMsg(this.el); | ||
|
|
@@ -258,8 +263,7 @@ export class Header implements ComponentInterface { | |
| * in the condense header. Without it, there is nothing to | ||
| * collapse into the main header toolbar. | ||
| */ | ||
| if (!this.hasLargeTitle()) { | ||
| printIonWarning( | ||
| '[ion-header] - The condense scroll effect requires an <ion-title size="large"> in the condense header.', | ||
| this.el | ||
|
|
@@ -329,12 +333,11 @@ export class Header implements ComponentInterface { | |
| // condense/fade via the deprecated `collapse` prop are iOS-only. | ||
| const isModeRestricted = scrollEffect === undefined && theme !== 'ios'; | ||
| const hasHide = effect === 'hide'; | ||
| const hasCondense = effect === 'condense' && !isModeRestricted && this.hasLargeTitle(); | ||
| const hasFade = effect === 'fade' && !isModeRestricted; | ||
| // The condense header should be hidden when | ||
| // - deprecated collapse prop is used on non-iOS (mode restricted), or | ||
| // - scrollEffect="condense" is set but no large ion-title is present | ||
| const isHiddenCondense = effect === 'condense' && !hasCondense; | ||
| // banner role must be at top level, so remove role if inside a menu | ||
| const roleType = isHiddenCondense ? 'none' : getRoleType(hostContext('ion-menu', this.el)); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,9 @@ | ||
| import { readTask, writeTask } from '@stencil/core'; | ||
| import { clamp } from '@utils/helpers'; | ||
|
|
||
| import { config } from '../../global/config'; | ||
| import type { IonTitleSize } from '../title/title.interface'; | ||
|
|
||
| const TRANSITION = 'all 0.2s ease-in-out'; | ||
| const ROLE_NONE = 'none'; | ||
| const ROLE_BANNER = 'banner'; | ||
|
|
@@ -211,11 +214,27 @@ export const setHeaderActive = (headerIndex: HeaderIndex, active = true) => { | |
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Checks the `size` prop, then the attribute (the header can render before | ||
| * the title is defined), then the `IonTitle.size` config. | ||
| * | ||
| * @internal | ||
| * @param ionTitleEl - The title to check. | ||
| * @returns Whether the title is large. | ||
| */ | ||
| export const isLargeTitle = (ionTitleEl: HTMLIonTitleElement) => { | ||
| const attributeSize = ionTitleEl.getAttribute('size') as IonTitleSize | null; | ||
| const configSize = config.getObjectValue('IonTitle.size') as IonTitleSize | undefined; | ||
|
Member
There was a problem hiding this comment. Non-blocking, possible follow-up for FW-6843
Could the header migration work out the collapsing title from where it sits rather than from its size? For example, treat the title inside This wouldn't break anything: |
||
| const size = ionTitleEl.size ?? attributeSize ?? configSize; | ||
|
|
||
| return size === 'large'; | ||
| }; | ||
|
|
||
| export const scaleLargeTitles = (toolbars: ToolbarIndex[] = [], scale = 1, transition = false) => { | ||
| toolbars.forEach((toolbar) => { | ||
| const ionTitle = toolbar.ionTitleEl; | ||
| const titleDiv = toolbar.innerTitleEl; | ||
| if (!ionTitle || !isLargeTitle(ionTitle)) { | ||
| return; | ||
| } | ||
|
|
||
|
|
||
|
Contributor
Author
There was a problem hiding this comment. The title in this snapshot now follows the page's md theme instead of the header's |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| import { newSpecPage } from '@stencil/core/testing'; | ||
|
|
||
| import { config } from '../../../global/config'; | ||
| import { ToolbarTitle } from '../../title/title'; | ||
| import { Header } from '../header'; | ||
|
|
||
| describe('header: condense', () => { | ||
| afterEach(() => { | ||
| config.reset({}); | ||
| }); | ||
|
|
||
| it('should condense when the title size is large', async () => { | ||
| const page = await newSpecPage({ | ||
| components: [Header, ToolbarTitle], | ||
| html: `<ion-header scroll-effect="condense"><ion-title size="large">Title</ion-title></ion-header>`, | ||
| }); | ||
|
|
||
| expect(page.root!.classList.contains('header-collapse-condense')).toBe(true); | ||
| }); | ||
|
|
||
| it('should condense when the config sets a large title size', async () => { | ||
| config.reset({ | ||
| customTheme: { config: { components: { IonTitle: { size: 'large' } } } }, | ||
| }); | ||
|
|
||
| const page = await newSpecPage({ | ||
| components: [Header, ToolbarTitle], | ||
| html: `<ion-header scroll-effect="condense"><ion-title>Title</ion-title></ion-header>`, | ||
| }); | ||
|
|
||
| expect(page.root!.classList.contains('header-collapse-condense')).toBe(true); | ||
| }); | ||
|
|
||
| it('should hide the header when the title is not large', async () => { | ||
| const page = await newSpecPage({ | ||
| components: [Header, ToolbarTitle], | ||
| html: `<ion-header scroll-effect="condense"><ion-title>Title</ion-title></ion-header>`, | ||
| }); | ||
|
|
||
| expect(page.root!.classList.contains('header-collapse-condense')).toBe(false); | ||
| expect(page.root!.classList.contains('header-collapse-condense-hidden')).toBe(true); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,7 +33,7 @@ | |
| </ion-header> | ||
|
|
||
| <ion-header> | ||
| <ion-toolbar class="toolbar-title-size-medium"> | ||
| <ion-buttons slot="start"> | ||
| <ion-back-button default-href="#"></ion-back-button> | ||
| </ion-buttons> | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.