Skip to content
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

docs(d, f, g, and h-named components): update api description refs #8540

Merged
merged 8 commits into from
Jan 3, 2024
Merged

docs(d, f, g, and h-named components): update api description refs #8540

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cd095b6
docs(d-components): update api description refs
DitwanP Jan 2, 2024
a4180f5
docs(f, g, and h-named components): update api description refs
DitwanP Jan 2, 2024
3e0fb81
Merge branch 'main' of https://github.com/Esri/calcite-design-system …
DitwanP Jan 2, 2024
abdcead
adding optional tags back in
DitwanP Jan 3, 2024
59b2324
Merge branch 'main' of https://github.com/Esri/calcite-design-system …
DitwanP Jan 3, 2024
600157b
cleanup selectionMode prop description
DitwanP Jan 3, 2024
36efb6e
change "Emits" to "Fires" for Events docs consistency
DitwanP Jan 3, 2024
9654c74
Merge branch 'main' of https://github.com/Esri/calcite-design-system …
DitwanP Jan 3, 2024
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
96 changes: 48 additions & 48 deletions packages/calcite-components/src/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1327,11 +1327,11 @@ export namespace Components {
*/
"disabled": boolean;
/**
* Date is the end of date range
* Date is the end of date range.
*/
"endOfRange": boolean;
/**
* Date is currently highlighted as part of the range
* Date is currently highlighted as part of the range,
*/
"highlighted": boolean;
/**
Expand All @@ -1343,7 +1343,7 @@ export namespace Components {
*/
"rangeEdge": "start" | "end" | undefined;
/**
* Date is being hovered and within the set range
* Date is being hovered and within the set range.
*/
"rangeHover": boolean;
/**
Expand All @@ -1355,7 +1355,7 @@ export namespace Components {
*/
"selected": boolean;
/**
* Date is the start of date range
* Date is the start of date range.
*/
"startOfRange": boolean;
/**
Expand All @@ -1365,23 +1365,23 @@ export namespace Components {
}
interface CalciteDatePickerMonth {
/**
* Date currently active.
* The currently active Date.
*/
"activeDate": Date;
/**
* The DateTimeFormat used to provide screen reader labels.
*/
"dateTimeFormat": Intl.DateTimeFormat;
/**
* End date currently active
* End date currently active.
*/
"endDate"?: Date;
"endDate": Date;
/**
* The range of dates currently being hovered
* The range of dates currently being hovered.
*/
"hoverRange": HoverRange;
/**
* CLDR locale data for current locale
* CLDR locale data for current locale.
*/
"localeData": DateLocaleData;
/**
Expand All @@ -1403,19 +1403,19 @@ export namespace Components {
/**
* Start date currently active.
*/
"startDate"?: Date;
"startDate": Date;
}
interface CalciteDatePickerMonthHeader {
/**
* Focused date with indicator (will become selected date if user proceeds)
* The focused date is indicated and will become the selected date if the user proceeds.
*/
"activeDate": Date;
/**
* Specifies the number at which section headings should start.
*/
"headingLevel": HeadingLevel;
/**
* CLDR locale data for translated calendar info
* CLDR locale data for translated calendar info.
*/
"localeData": DateLocaleData;
/**
Expand Down Expand Up @@ -1507,7 +1507,7 @@ export namespace Components {
*/
"scale": Scale;
/**
* Specifies the selection mode for `calcite-dropdown-item` children, defaults to `single`: - `multiple` allows any number of selected items, - `single` allows only one selection (default), - `none` doesn't allow for any selection.
* Specifies the selection mode for `calcite-dropdown-item` children: - `"multiple"` allows any number of selected items, - `"single"` allows only one selection, - `"none"` doesn't allow for any selection.
*/
"selectionMode": Extract<"none" | "single" | "multiple", SelectionMode>;
}
Expand Down Expand Up @@ -1743,27 +1743,27 @@ export namespace Components {
}
interface CalciteGraph {
/**
* Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value
* Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value.
*/
"colorStops": ColorStop[];
/**
* Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value
* Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value.
*/
"data": DataSeries;
/**
* End of highlight color if highlighting range
* End of highlight color if highlighting range.
*/
"highlightMax": number;
/**
* Start of highlight color if highlighting range
* Start of highlight color if highlighting range.
*/
"highlightMin": number;
/**
* Highest point of the range
* Highest point of the range.
*/
"max": number;
/**
* Lowest point of the range
* Lowest point of the range.
*/
"min": number;
}
Expand All @@ -1777,7 +1777,7 @@ export namespace Components {
*/
"disabled": boolean;
/**
* Value for the button title attribute
* Value for the button title attribute.
*/
"dragHandle": string;
"label": string;
Expand All @@ -1786,7 +1786,7 @@ export namespace Components {
*/
"messageOverrides": Partial<HandleMessages>;
/**
* Made into a prop for testing purposes only
* Made into a prop for testing purposes only.
*/
"messages": HandleMessages;
/**
Expand Down Expand Up @@ -8608,19 +8608,19 @@ declare namespace LocalJSX {
*/
"disabled"?: boolean;
/**
* Date is the end of date range
* Date is the end of date range.
*/
"endOfRange"?: boolean;
/**
* Date is currently highlighted as part of the range
* Date is currently highlighted as part of the range,
*/
"highlighted"?: boolean;
/**
* Emitted when user selects day
* Emits when user selects day.
*/
"onCalciteDaySelect"?: (event: CalciteDatePickerDayCustomEvent<void>) => void;
/**
* Emitted when user hovers over a day
* Emits when user hovers over a day.
*/
"onCalciteInternalDayHover"?: (event: CalciteDatePickerDayCustomEvent<void>) => void;
/**
Expand All @@ -8632,7 +8632,7 @@ declare namespace LocalJSX {
*/
"rangeEdge"?: "start" | "end" | undefined;
/**
* Date is being hovered and within the set range
* Date is being hovered and within the set range.
*/
"rangeHover"?: boolean;
/**
Expand All @@ -8644,7 +8644,7 @@ declare namespace LocalJSX {
*/
"selected"?: boolean;
/**
* Date is the start of date range
* Date is the start of date range.
*/
"startOfRange"?: boolean;
/**
Expand All @@ -8654,23 +8654,23 @@ declare namespace LocalJSX {
}
interface CalciteDatePickerMonth {
/**
* Date currently active.
* The currently active Date.
*/
"activeDate"?: Date;
/**
* The DateTimeFormat used to provide screen reader labels.
*/
"dateTimeFormat"?: Intl.DateTimeFormat;
/**
* End date currently active
* End date currently active.
*/
"endDate"?: Date;
/**
* The range of dates currently being hovered
* The range of dates currently being hovered.
*/
"hoverRange"?: HoverRange;
/**
* CLDR locale data for current locale
* CLDR locale data for current locale.
*/
"localeData"?: DateLocaleData;
/**
Expand All @@ -8686,12 +8686,12 @@ declare namespace LocalJSX {
*/
"onCalciteInternalDatePickerActiveDateChange"?: (event: CalciteDatePickerMonthCustomEvent<Date>) => void;
/**
* Event emitted when user hovers the date.
* Emits when user hovers the date.
*/
"onCalciteInternalDatePickerHover"?: (event: CalciteDatePickerMonthCustomEvent<Date>) => void;
"onCalciteInternalDatePickerMouseOut"?: (event: CalciteDatePickerMonthCustomEvent<void>) => void;
/**
* Event emitted when user selects the date.
* Emits when user selects the date.
*/
"onCalciteInternalDatePickerSelect"?: (event: CalciteDatePickerMonthCustomEvent<Date>) => void;
/**
Expand All @@ -8709,15 +8709,15 @@ declare namespace LocalJSX {
}
interface CalciteDatePickerMonthHeader {
/**
* Focused date with indicator (will become selected date if user proceeds)
* The focused date is indicated and will become the selected date if the user proceeds.
*/
"activeDate"?: Date;
/**
* Specifies the number at which section headings should start.
*/
"headingLevel"?: HeadingLevel;
/**
* CLDR locale data for translated calendar info
* CLDR locale data for translated calendar info.
*/
"localeData"?: DateLocaleData;
/**
Expand Down Expand Up @@ -8825,7 +8825,7 @@ declare namespace LocalJSX {
*/
"scale"?: Scale;
/**
* Specifies the selection mode for `calcite-dropdown-item` children, defaults to `single`: - `multiple` allows any number of selected items, - `single` allows only one selection (default), - `none` doesn't allow for any selection.
* Specifies the selection mode for `calcite-dropdown-item` children: - `"multiple"` allows any number of selected items, - `"single"` allows only one selection, - `"none"` doesn't allow for any selection.
*/
"selectionMode"?: Extract<"none" | "single" | "multiple", SelectionMode>;
}
Expand Down Expand Up @@ -8855,7 +8855,7 @@ declare namespace LocalJSX {
*/
"label"?: string;
/**
* Fires when the component is selected.
* Emits when the component is selected.
*/
"onCalciteDropdownItemSelect"?: (event: CalciteDropdownItemCustomEvent<void>) => void;
"onCalciteInternalDropdownCloseRequest"?: (event: CalciteDropdownItemCustomEvent<void>) => void;
Expand Down Expand Up @@ -8948,7 +8948,7 @@ declare namespace LocalJSX {
*/
"messages"?: FilterMessages;
/**
* This event fires when the filter text changes.
* Emits when the filter text changes.
*/
"onCalciteFilterChange"?: (event: CalciteFilterCustomEvent<void>) => void;
/**
Expand Down Expand Up @@ -9050,27 +9050,27 @@ declare namespace LocalJSX {
}
interface CalciteGraph {
/**
* Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value
* Array of values describing a single color stop ([offset, color, opacity]) These color stops should be sorted by offset value.
*/
"colorStops"?: ColorStop[];
/**
* Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value
* Array of tuples describing a single data point ([x, y]) These data points should be sorted by x-axis value.
*/
"data"?: DataSeries;
/**
* End of highlight color if highlighting range
* End of highlight color if highlighting range.
*/
"highlightMax"?: number;
/**
* Start of highlight color if highlighting range
* Start of highlight color if highlighting range.
*/
"highlightMin"?: number;
/**
* Highest point of the range
* Highest point of the range.
*/
"max": number;
/**
* Lowest point of the range
* Lowest point of the range.
*/
"min": number;
}
Expand All @@ -9084,7 +9084,7 @@ declare namespace LocalJSX {
*/
"disabled"?: boolean;
/**
* Value for the button title attribute
* Value for the button title attribute.
*/
"dragHandle"?: string;
"label"?: string;
Expand All @@ -9093,19 +9093,19 @@ declare namespace LocalJSX {
*/
"messageOverrides"?: Partial<HandleMessages>;
/**
* Made into a prop for testing purposes only
* Made into a prop for testing purposes only.
*/
"messages"?: HandleMessages;
/**
* Emits whenever the component is selected or unselected.
*/
"onCalciteHandleChange"?: (event: CalciteHandleCustomEvent<void>) => void;
/**
* Emitted when the handle is selected and the up or down arrow key is pressed.
* Emits when the handle is selected and the up or down arrow key is pressed.
*/
"onCalciteHandleNudge"?: (event: CalciteHandleCustomEvent<HandleNudge>) => void;
/**
* Emitted when the assistive text has changed.
* Emits when the assistive text has changed.
*/
"onCalciteInternalAssistiveTextChange"?: (event: CalciteHandleCustomEvent<HandleChange>) => void;
/**
Expand Down
12 changes: 6 additions & 6 deletions packages/calcite-components/src/components/date-picker-day/date-picker-day.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export class DatePickerDay implements InteractiveComponent {
/** When `true`, the component is selected. */
@Prop({ reflect: true }) selected = false;

/** Date is currently highlighted as part of the range */
/** Date is currently highlighted as part of the range, */
@Prop({ reflect: true }) highlighted = false;

/** When `true`, activates the component's range mode to allow a start and end date. */
Expand All @@ -67,13 +67,13 @@ export class DatePickerDay implements InteractiveComponent {
*/
@Prop({ reflect: true }) rangeEdge: "start" | "end" | undefined;

/** Date is the start of date range */
/** Date is the start of date range. */
@Prop({ reflect: true }) startOfRange = false;

/** Date is the end of date range */
/** Date is the end of date range. */
@Prop({ reflect: true }) endOfRange = false;

/** Date is being hovered and within the set range */
/** Date is being hovered and within the set range. */
@Prop({ reflect: true }) rangeHover = false;

/** When `true`, the component is active. */
Expand Down Expand Up @@ -122,12 +122,12 @@ export class DatePickerDay implements InteractiveComponent {
//--------------------------------------------------------------------------

/**
* Emitted when user selects day
* Fires when user selects day.
*/
@Event({ cancelable: false }) calciteDaySelect: EventEmitter<void>;

/**
* Emitted when user hovers over a day
* Fires when user hovers over a day.
*
* @internal
*/
Expand Down
Loading
Loading