Skip to content

refactor(themes): align recipe keys, interface files and prop arrays #31671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thetaPC wants to merge 2 commits into
base: ionic-modular
Choose a base branch
from
+227 −411
Open

refactor(themes): align recipe keys, interface files and prop arrays #31671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e71754
refactor(themes): align recipe key nesting and interface file names
thetaPC Oct 29, 2026
aaacec3
docs(themes): document component file conventions
thetaPC Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions core/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ import { OverlayEventDetail } from "./utils/overlays-interface";
import { IonicSafeString } from "./utils/sanitization";
import { AlertButton, AlertInput } from "./components/alert/alert-interface";
import { Hue } from "./themes/themes.interfaces";
import { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from "./components/badge/badge.interfaces";
import { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from "./components/badge/badge.interface";
import { RouteID, RouterDirection, RouterEventDetail, RouteWrite } from "./components/router/utils/interface";
import { BreadcrumbCollapsedClickEventDetail } from "./components/breadcrumb/breadcrumb-interface";
import { CheckboxChangeEventDetail } from "./components/checkbox/checkbox-interface";
import { IonChipFill, IonChipShape, IonChipSize } from "./components/chip/chip.interfaces";
import { IonChipFill, IonChipShape, IonChipSize } from "./components/chip/chip.interface";
import { IonColValue } from "./components/col/col.interface";
import { ScrollBaseDetail, ScrollDetail } from "./components/content/content.interfaces";
import { ScrollBaseDetail, ScrollDetail } from "./components/content/content.interface";
import { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimeHourCycle, DatetimeParts, DatetimePresentation, FormatOptions, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
import { FooterScrollEffect } from "./components/footer/footer-interface";
import { IonGalleryColumns, IonGalleryGap } from "./components/gallery/gallery.interface";
Expand All @@ -33,7 +33,7 @@ import { ViewController } from "./components/nav/view-controller";
import { PickerChangeEventDetail } from "./components/picker/picker-interfaces";
import { PickerColumnChangeEventDetail, PickerColumnValue } from "./components/picker-column/picker-column-interfaces";
import { PopoverSize, PositionAlign, PositionReference, PositionSide, TriggerAction } from "./components/popover/popover-interface";
import { IonProgressBarShape } from "./components/progress-bar/progress-bar.interfaces";
import { IonProgressBarShape } from "./components/progress-bar/progress-bar.interface";
import { RadioGroupChangeEventDetail, RadioGroupCompareFn } from "./components/radio-group/radio-group-interface";
import { PinFormatter, RangeChangeEventDetail, RangeKnobMoveEndEventDetail, RangeKnobMoveStartEventDetail, RangeValue } from "./components/range/range-interface";
import { RefresherEventDetail, RefresherPullEndEventDetail } from "./components/refresher/refresher-interface";
Expand All @@ -47,7 +47,7 @@ import { SegmentViewScrollEvent } from "./components/segment-view/segment-view-i
import { SelectChangeEventDetail, SelectCompareFn, SelectInterface } from "./components/select/select-interface";
import { SelectModalOption } from "./components/select-modal/select-modal-interface";
import { SelectPopoverOption } from "./components/select-popover/select-popover-interface";
import { SpinnerSize } from "./components/spinner/spinner.interfaces";
import { SpinnerSize } from "./components/spinner/spinner.interface";
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";
Expand All @@ -60,13 +60,13 @@ export { OverlayEventDetail } from "./utils/overlays-interface";
export { IonicSafeString } from "./utils/sanitization";
export { AlertButton, AlertInput } from "./components/alert/alert-interface";
export { Hue } from "./themes/themes.interfaces";
export { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from "./components/badge/badge.interfaces";
export { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from "./components/badge/badge.interface";
export { RouteID, RouterDirection, RouterEventDetail, RouteWrite } from "./components/router/utils/interface";
export { BreadcrumbCollapsedClickEventDetail } from "./components/breadcrumb/breadcrumb-interface";
export { CheckboxChangeEventDetail } from "./components/checkbox/checkbox-interface";
export { IonChipFill, IonChipShape, IonChipSize } from "./components/chip/chip.interfaces";
export { IonChipFill, IonChipShape, IonChipSize } from "./components/chip/chip.interface";
export { IonColValue } from "./components/col/col.interface";
export { ScrollBaseDetail, ScrollDetail } from "./components/content/content.interfaces";
export { ScrollBaseDetail, ScrollDetail } from "./components/content/content.interface";
export { DatetimeChangeEventDetail, DatetimeHighlight, DatetimeHighlightCallback, DatetimeHourCycle, DatetimeParts, DatetimePresentation, FormatOptions, TitleSelectedDatesFormatter } from "./components/datetime/datetime-interface";
export { FooterScrollEffect } from "./components/footer/footer-interface";
export { IonGalleryColumns, IonGalleryGap } from "./components/gallery/gallery.interface";
Expand All @@ -81,7 +81,7 @@ export { ViewController } from "./components/nav/view-controller";
export { PickerChangeEventDetail } from "./components/picker/picker-interfaces";
export { PickerColumnChangeEventDetail, PickerColumnValue } from "./components/picker-column/picker-column-interfaces";
export { PopoverSize, PositionAlign, PositionReference, PositionSide, TriggerAction } from "./components/popover/popover-interface";
export { IonProgressBarShape } from "./components/progress-bar/progress-bar.interfaces";
export { IonProgressBarShape } from "./components/progress-bar/progress-bar.interface";
export { RadioGroupChangeEventDetail, RadioGroupCompareFn } from "./components/radio-group/radio-group-interface";
export { PinFormatter, RangeChangeEventDetail, RangeKnobMoveEndEventDetail, RangeKnobMoveStartEventDetail, RangeValue } from "./components/range/range-interface";
export { RefresherEventDetail, RefresherPullEndEventDetail } from "./components/refresher/refresher-interface";
Expand All @@ -95,7 +95,7 @@ export { SegmentViewScrollEvent } from "./components/segment-view/segment-view-i
export { SelectChangeEventDetail, SelectCompareFn, SelectInterface } from "./components/select/select-interface";
export { SelectModalOption } from "./components/select-modal/select-modal-interface";
export { SelectPopoverOption } from "./components/select-popover/select-popover-interface";
export { SpinnerSize } from "./components/spinner/spinner.interfaces";
export { SpinnerSize } from "./components/spinner/spinner.interface";
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";
Expand Down
2 changes: 1 addition & 1 deletion core/src/components/avatar/test/badge/avatar.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { expect } from '@playwright/test';
import { configs, test } from '@utils/test/playwright';

import { ION_BADGE_SIZES, ION_BADGE_VERTICAL_POSITIONS } from '../../../badge/badge.interfaces';
import { ION_BADGE_SIZES, ION_BADGE_VERTICAL_POSITIONS } from '../../../badge/badge.interface';

configs({ modes: ['md', 'ios', 'ionic-md'] }).forEach(({ config, screenshot, title }) => {
test.describe(title('avatar: badge'), () => {
Expand Down
0 .../src/components/badge/badge.interfaces.ts → core/src/components/badge/badge.interface.ts
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion core/src/components/badge/badge.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { config } from '../../global/config';
import type { Color } from '../../interface';
import type { Hue } from '../../themes/themes.interfaces';

import type { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from './badge.interfaces';
import type { IonBadgeShape, IonBadgeSize, IonBadgeVerticalPosition } from './badge.interface';

/**
* @virtualProp {"ios" | "md"} mode - The mode determines the platform behaviors of the component.
Expand Down
2 changes: 1 addition & 1 deletion core/src/components/badge/test/shape/badge.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { expect } from '@playwright/test';
import { configs, test } from '@utils/test/playwright';

import { ION_BADGE_SHAPES } from '../../../badge/badge.interfaces';
import { ION_BADGE_SHAPES } from '../../../badge/badge.interface';

/**
* This behavior does not vary across directions.
Expand Down
2 changes: 1 addition & 1 deletion core/src/components/badge/test/size/badge.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { expect } from '@playwright/test';
import { configs, test } from '@utils/test/playwright';

import { ION_BADGE_SIZES } from '../../../badge/badge.interfaces';
import { ION_BADGE_SIZES } from '../../../badge/badge.interface';

/**
* This behavior does not vary across directions.
Expand Down
2 changes: 1 addition & 1 deletion core/src/components/button/test/badge/button.e2e.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { expect } from '@playwright/test';
import { configs, test } from '@utils/test/playwright';

import { ION_BADGE_SIZES, ION_BADGE_VERTICAL_POSITIONS } from '../../../badge/badge.interfaces';
import { ION_BADGE_SIZES, ION_BADGE_VERTICAL_POSITIONS } from '../../../badge/badge.interface';

configs({ modes: ['md', 'ios', 'ionic-md'] }).forEach(({ config, screenshot, title }) => {
test.describe(title('button: badge'), () => {
Expand Down
17 changes: 12 additions & 5 deletions core/src/components/chip/chip.interfaces.ts → core/src/components/chip/chip.interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ import type { IonPadding, IonMargin, Hue } from '../../themes/themes.interfaces'

export type IonChipRecipe = {
letterSpacing?: string | number;
lineHeight?: string | number;
line?: {
height?: string | number;
};
margin?: IonMargin;
padding?: IonPadding;
gap?: string | number;
Expand Down Expand Up @@ -71,7 +73,9 @@ type IonChipColorDefinition = {
};

type IonChipSizeDefinition = {
minHeight?: string | number;
min?: {
height?: string | number;
};

font?: {
size?: string | number;
Expand Down Expand Up @@ -116,6 +120,9 @@ export type IonChipConfig = {
shape?: IonChipShape;
};

export type IonChipFill = 'outline' | 'solid';
export type IonChipSize = 'small' | 'large';
export type IonChipShape = 'soft' | 'round' | 'rectangular';
export const ION_CHIP_FILLS = ['solid', 'outline'] as const;
export type IonChipFill = (typeof ION_CHIP_FILLS)[number];
export const ION_CHIP_SIZES = ['small', 'large'] as const;
export type IonChipSize = (typeof ION_CHIP_SIZES)[number];
export const ION_CHIP_SHAPES = ['soft', 'round', 'rectangular'] as const;
export type IonChipShape = (typeof ION_CHIP_SHAPES)[number];
2 changes: 1 addition & 1 deletion core/src/components/chip/chip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { config } from '../../global/config';
import type { Color } from '../../interface';
import type { Hue } from '../../themes/themes.interfaces';

import type { IonChipFill, IonChipSize, IonChipShape } from './chip.interfaces';
import type { IonChipFill, IonChipSize, IonChipShape } from './chip.interface';

/**
* @virtualProp {"ios" | "md"} mode - The mode determines the platform behaviors of the component.
Expand Down
Loading
Loading