Skip to content

Commit b193e4a

Browse files
Add @publicdocs to POS component Events and Slots interfaces
Ensures ClickableEvents and other Events/Slots (EmptyStateSlots, ChoiceListEvents, DateFieldEvents, ModalEvents, ModalSlots, TextFieldEvents, TextFieldSlots, SearchFieldEvents, TimeFieldEvents, NumberFieldEvents, NumberFieldSlots, DatePickerEvents, DateSpinnerEvents, SectionSlots, TimePickerEvents, PageSlots, PosBlockSlots) are included in generated POS docs. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 1378f45 commit b193e4a

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

packages/ui-extensions/src/surfaces/point-of-sale/components.d.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4923,6 +4923,7 @@ declare module 'preact' {
49234923
/** @publicDocs */
49244924
export type { BadgeJSXProps, BannerJSXProps, BoxJSXProps, ButtonJSXProps, ChoiceJSXProps, ChoiceListJSXProps, ClickableJSXProps, DateFieldJSXProps, DatePickerJSXProps, DateSpinnerJSXProps, DividerJSXProps, EmailFieldJSXProps, EmbedJSXProps, EmptyStateJSXProps, HeadingJSXProps, IconJSXProps, ImageJSXProps, LinkJSXProps, ModalJSXProps, NumberFieldJSXProps, PageJSXProps, PosBlockJSXProps, QrCodeJSXProps, ScrollBoxJSXProps, SearchFieldJSXProps, SectionJSXProps, SpinnerJSXProps, StackJSXProps, SwitchJSXProps, TabJSXProps, TabListJSXProps, TabPanelJSXProps, TabsJSXProps, TextAreaJSXProps, TextFieldJSXProps, TextJSXProps, TileJSXProps, TimeFieldJSXProps, TimePickerJSXProps };
49254925

4926+
/** @publicDocs */
49264927
interface LinkEvents {
49274928
/** Called when the link is activated. */
49284929
click?: (event: CallbackEvent<typeof tagName$a>) => void;
@@ -4962,6 +4963,7 @@ interface Link {
49624963
accessibilityLabel?: string;
49634964
}
49644965

4966+
/** @publicDocs */
49654967
interface EmptyStateSlots {
49664968
/** The primary action to perform, provided as a button or link type element. */
49674969
'primary-action'?: HTMLElement;
@@ -5449,6 +5451,7 @@ interface ScrollBox {
54495451
id?: string;
54505452
}
54515453

5454+
/** @publicDocs */
54525455
interface TileEvents {
54535456
/** Callback when the Tile is activated. */
54545457
click?: (event: CallbackEvent<typeof tagName$d>) => void;
@@ -5487,6 +5490,7 @@ interface Tile {
54875490
subheading?: string;
54885491
}
54895492

5493+
/** @publicDocs */
54905494
interface BannerSlots {
54915495
/** The action taken when the Banner is pressed. */
54925496
'primary-action'?: HTMLElement;
@@ -5797,6 +5801,7 @@ interface Badge {
57975801
id?: string;
57985802
}
57995803

5804+
/** @publicDocs */
58005805
interface ChoiceListEvents {
58015806
/** Callback when the user changes a choice. Fires simultaneously with onChange. */
58025807
input?: (event: CallbackEvent<typeof tagName$z>) => void;
@@ -5839,6 +5844,7 @@ interface Choice {
58395844
selected?: boolean;
58405845
}
58415846

5847+
/** @publicDocs */
58425848
interface DateFieldEvents {
58435849
/** Callback when the user makes any changes in the field. */
58445850
input?: (event: CallbackEvent<typeof tagName$x>) => void;
@@ -5886,13 +5892,15 @@ interface DateField {
58865892
required?: boolean;
58875893
}
58885894

5895+
/** @publicDocs */
58895896
interface ModalEvents {
58905897
/** Callback when the modal is hidden. */
58915898
hide?: (event: CallbackEvent<typeof tagName$p>) => void | null;
58925899
/** Callback when the modal is shown. */
58935900
show?: (event: CallbackEvent<typeof tagName$p>) => void | null;
58945901
}
58955902

5903+
/** @publicDocs */
58965904
interface ModalSlots {
58975905
/**
58985906
* The primary action button displayed in the modal.
@@ -5914,6 +5922,7 @@ interface Modal {
59145922
heading?: string;
59155923
}
59165924

5925+
/** @publicDocs */
59175926
interface TextFieldEvents {
59185927
/** Callback when the user makes any changes in the field. */
59195928
input?: (event: CallbackEvent<typeof tagName$e>) => void;
@@ -5925,6 +5934,7 @@ interface TextFieldEvents {
59255934
focus?: (event: CallbackEvent<typeof tagName$e>) => void;
59265935
}
59275936

5937+
/** @publicDocs */
59285938
interface TextFieldSlots {
59295939
/** Additional content to be displayed in the field. Commonly used to display clickable text. */
59305940
'accessory'?: HTMLElement;
@@ -5973,6 +5983,7 @@ interface TextField {
59735983
maxLength?: number;
59745984
}
59755985

5986+
/** @publicDocs */
59765987
interface SearchFieldEvents {
59775988
/** Callback when the user changes the value in the field. */
59785989
input?: (event: CallbackEvent<typeof tagName$j>) => void;
@@ -5999,6 +6010,7 @@ interface SearchField {
59996010
value?: string;
60006011
}
60016012

6013+
/** @publicDocs */
60026014
interface ClickableEvents {
60036015
/** Callback when the element is activated. */
60046016
click?: (event: CallbackEvent<typeof tagName$y>) => void;
@@ -6022,6 +6034,7 @@ interface Clickable {
60226034
disabled?: boolean;
60236035
}
60246036

6037+
/** @publicDocs */
60256038
interface TimeFieldEvents {
60266039
/** Callback when the user makes any changes in the field. */
60276040
input?: (event: CallbackEvent<typeof tagName$c>) => void;
@@ -6082,6 +6095,7 @@ interface TimeField {
60826095
required?: boolean;
60836096
}
60846097

6098+
/** @publicDocs */
60856099
interface NumberFieldEvents {
60866100
/** Callback when the user makes any changes in the field. */
60876101
input?: (event: CallbackEvent<typeof tagName$o>) => void;
@@ -6093,6 +6107,7 @@ interface NumberFieldEvents {
60936107
focus?: (event: CallbackEvent<typeof tagName$o>) => void;
60946108
}
60956109

6110+
/** @publicDocs */
60966111
interface NumberFieldSlots {
60976112
/**
60986113
* Additional content to be displayed in the field. Commonly used to display clickable text.
@@ -6191,6 +6206,7 @@ interface NumberField {
61916206
min?: number;
61926207
}
61936208

6209+
/** @publicDocs */
61946210
interface DatePickerEvents {
61956211
/** Callback when the user selects a date from the picker. */
61966212
input?: (event: CallbackEvent<typeof tagName$w>) => void | null;
@@ -6223,6 +6239,7 @@ interface DatePicker {
62236239
value?: string;
62246240
}
62256241

6242+
/** @publicDocs */
62266243
interface DateSpinnerEvents {
62276244
/** Callback when the user makes a selection. */
62286245
input?: (event: CallbackEvent<typeof tagName$v>) => void | null;
@@ -6247,6 +6264,7 @@ interface DateSpinner {
62476264
value?: string;
62486265
}
62496266

6267+
/** @publicDocs */
62506268
interface SectionSlots {
62516269
/** Button element to display in the section heading. A single button is supported. */
62526270
'secondary-actions'?: HTMLElement;
@@ -6270,6 +6288,7 @@ interface Heading {
62706288
id?: string;
62716289
}
62726290

6291+
/** @publicDocs */
62736292
interface TimePickerEvents {
62746293
/** Callback when the user selects a time from the picker. */
62756294
input?: (event: CallbackEvent<typeof tagName$b>) => void | null;
@@ -6355,6 +6374,7 @@ interface Image {
63556374
alt?: string;
63566375
}
63576376

6377+
/** @publicDocs */
63586378
interface PageSlots {
63596379
/** Button element to display in the action bar. Only a single button is supported. */
63606380
'secondary-actions'?: HTMLElement;
@@ -6375,6 +6395,7 @@ interface Page {
63756395
id?: string;
63766396
}
63776397

6398+
/** @publicDocs */
63786399
interface PosBlockSlots {
63796400
/** The secondary actions to perform, provided as button or link type elements. */
63806401
'secondary-actions'?: HTMLElement;

0 commit comments

Comments
 (0)