Skip to content

Commit

Permalink
update api-report and READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
@radium-v
radium-v committed Aug 25, 2022
1 parent c059c20 commit 8352248
Show file tree
Hide file tree
Showing 7 changed files with 182 additions and 61 deletions.
131 changes: 115 additions & 16 deletions packages/web-components/fast-foundation/docs/api-report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,34 @@ export interface AnchoredRegionConfig {
}

// @public
export type AnchoredRegionPositionLabel = "start" | "insetStart" | "insetEnd" | "end" | "center";
export const AnchoredRegionPositionLabel: {
readonly start: "start";
readonly insetStart: "insetStart";
readonly insetEnd: "insetEnd";
readonly end: "end";
readonly center: "center";
};

// @public
export type AnchoredRegionPositionLabel = typeof AnchoredRegionPositionLabel[keyof typeof AnchoredRegionPositionLabel];

// @public
export function anchoredRegionTemplate(): ElementViewTemplate<FASTAnchoredRegion>;

// @public
export type AnchorOptions = StartEndOptions;

// @public
export const AnchorTarget: {
readonly _self: "_self";
readonly _blank: "_blank";
readonly _parent: "_parent";
readonly _top: "_top";
};

// @public
export type AnchorTarget = typeof AnchorTarget[keyof typeof AnchorTarget];

// @public
export function anchorTemplate(options?: AnchorOptions): ElementViewTemplate<FASTAnchor>;

Expand Down Expand Up @@ -102,7 +122,7 @@ export const AutoUpdateMode: {
readonly auto: "auto";
};

// @public (undocumented)
// @public
export type AutoUpdateMode = typeof AutoUpdateMode[keyof typeof AutoUpdateMode];

// @public
Expand All @@ -114,10 +134,24 @@ export type AvatarOptions = {
export function avatarTemplate(options?: AvatarOptions): ElementViewTemplate<FASTAvatar>;

// @public
export type AxisPositioningMode = "uncontrolled" | "locktodefault" | "dynamic";
export const AxisPositioningMode: {
readonly uncontrolled: "uncontrolled";
readonly locktodefault: "locktodefault";
readonly dynamic: "dynamic";
};

// @public
export type AxisScalingMode = "anchor" | "fill" | "content";
export type AxisPositioningMode = typeof AxisPositioningMode[keyof typeof AxisPositioningMode];

// @public
export const AxisScalingMode: {
readonly anchor: "anchor";
readonly content: "content";
readonly fill: "fill";
};

// @public
export type AxisScalingMode = typeof AxisScalingMode[keyof typeof AxisScalingMode];

// @public
export function badgeTemplate(): ElementViewTemplate<FASTBadge>;
Expand All @@ -139,6 +173,16 @@ export type ButtonOptions = StartEndOptions;
// @public
export function buttonTemplate(options?: ButtonOptions): ElementViewTemplate<FASTButton>;

// @public
export const ButtonType: {
readonly submit: "submit";
readonly reset: "reset";
readonly button: "button";
};

// @public
export type ButtonType = typeof ButtonType[keyof typeof ButtonType];

// @public
export function calendarCellTemplate(options: CalendarOptions, todayString: string): ViewTemplate<CalendarDateInfo>;

Expand Down Expand Up @@ -534,6 +578,16 @@ export interface DesignTokenSubscriber<T extends DesignToken<any>> {
// @public
export function dialogTemplate(): ElementViewTemplate<FASTDialog>;

// Warning: (ae-internal-missing-underscore) The name "Dimension" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export interface Dimension {
// (undocumented)
height: number;
// (undocumented)
width: number;
}

// @public @deprecated
export const disabledCursor = "not-allowed";

Expand Down Expand Up @@ -606,7 +660,7 @@ export class FASTAnchor extends FASTElement {
ping: string;
referrerpolicy: string;
rel: string;
target: "_self" | "_blank" | "_parent" | "_top";
target: AnchorTarget;
type: string;
}

Expand Down Expand Up @@ -761,9 +815,9 @@ export class FASTButton extends FormAssociatedButton {
formtarget: "_self" | "_blank" | "_parent" | "_top";
// (undocumented)
protected formtargetChanged(): void;
type: "submit" | "reset" | "button";
type: ButtonType;
// (undocumented)
protected typeChanged(previous: "submit" | "reset" | "button" | void, next: "submit" | "reset" | "button"): void;
protected typeChanged(previous: ButtonType | undefined, next: ButtonType): void;
validate(): void;
}

Expand Down Expand Up @@ -1057,7 +1111,7 @@ export class FASTHorizontalScroll extends FASTElement {
// (undocumented)
disconnectedCallback(): void;
duration: string;
easing: ScrollEasing;
easing: ScrollEasing | string;
flippersHiddenFromAT: boolean;
keyupHandler(e: Event & KeyboardEvent): void;
nextFlipperContainer: HTMLDivElement;
Expand Down Expand Up @@ -1430,7 +1484,7 @@ export class FASTPicker extends FormAssociatedPicker {
menuOptionTemplate: ViewTemplate;
// (undocumented)
protected menuOptionTemplateChanged(): void;
menuPlacement: menuConfigs;
menuPlacement: MenuPlacement;
// (undocumented)
protected menuPlacementChanged(): void;
// @internal
Expand Down Expand Up @@ -2236,7 +2290,17 @@ export const getDirection: (rootNode: HTMLElement) => Direction;
export const hidden = ":host([hidden]){display:none}";

// @public
export type HorizontalPosition = "start" | "end" | "left" | "right" | "center" | "unset";
export const HorizontalPosition: {
readonly start: "start";
readonly end: "end";
readonly left: "left";
readonly right: "right";
readonly center: "center";
readonly unset: "unset";
};

// @public
export type HorizontalPosition = typeof HorizontalPosition[keyof typeof HorizontalPosition];

// @public
export type HorizontalScrollOptions = StartEndOptions & {
Expand All @@ -2248,7 +2312,13 @@ export type HorizontalScrollOptions = StartEndOptions & {
export function horizontalScrollTemplate(options?: HorizontalScrollOptions): ElementViewTemplate<FASTHorizontalScroll>;

// @public
export type HorizontalScrollView = "default" | "mobile";
export const HorizontalScrollView: {
readonly default: "default";
readonly mobile: "mobile";
};

// @public
export type HorizontalScrollView = typeof HorizontalScrollView[keyof typeof HorizontalScrollView];

// Warning: (ae-internal-missing-underscore) The name "interactiveCalendarGridTemplate" should be prefixed with an underscore because the declaration is marked as @internal
//
Expand Down Expand Up @@ -2296,9 +2366,6 @@ export class MatchMediaStyleSheetBehavior extends MatchMediaBehavior {
// @public
export type MediaQueryListListener = (this: MediaQueryList, ev?: MediaQueryListEvent) => void;

// @beta
export type menuConfigs = "bottom" | "bottom-fill" | "tallest" | "tallest-fill" | "top" | "top-fill";

// @public
export type MenuItemColumnCount = 0 | 1 | 2;

Expand All @@ -2323,6 +2390,19 @@ export type MenuItemRole = typeof MenuItemRole[keyof typeof MenuItemRole];
// @public
export function menuItemTemplate(options: MenuItemOptions): ElementViewTemplate<FASTMenuItem>;

// @beta
export const MenuPlacement: {
readonly bottom: "bottom";
readonly bottomFill: "bottom-fill";
readonly tallest: "tallest";
readonly tallestFill: "tallest-fill";
readonly top: "top";
readonly topFill: "top-fill";
};

// @beta
export type MenuPlacement = typeof MenuPlacement[keyof typeof MenuPlacement];

// @public
export function menuTemplate(): ElementViewTemplate<FASTMenu>;

Expand Down Expand Up @@ -2457,7 +2537,15 @@ export const roleForMenuItem: {
};

// @public
export type ScrollEasing = "linear" | "ease-in" | "ease-out" | "ease-in-out" | string;
export const ScrollEasing: {
readonly linear: "linear";
readonly easeIn: "ease-in";
readonly easeOut: "ease-out";
readonly easeInOut: "ease-in-out";
};

// @public
export type ScrollEasing = typeof ScrollEasing[keyof typeof ScrollEasing];

// @public
export type SearchOptions = StartEndOptions;
Expand Down Expand Up @@ -2639,11 +2727,14 @@ export const TooltipPosition: {
readonly right: "right";
readonly bottom: "bottom";
readonly left: "left";
readonly center: "center";
readonly start: "start";
readonly end: "end";
readonly topLeft: "top-left";
readonly topCenter: "top-center";
readonly topRight: "top-right";
readonly bottomLeft: "bottom-left";
readonly bottomCenter: "bottom-center";
readonly bottomRight: "bottom-right";
readonly topStart: "top-start";
readonly topEnd: "top-end";
Expand All @@ -2669,7 +2760,15 @@ export function treeItemTemplate(options?: TreeItemOptions): ElementViewTemplate
export function treeViewTemplate(): ElementViewTemplate<FASTTreeView>;

// @public
export type VerticalPosition = "top" | "bottom" | "center" | "unset";
export const VerticalPosition: {
readonly top: "top";
readonly bottom: "bottom";
readonly center: "center";
readonly unset: "unset";
};

// @public
export type VerticalPosition = typeof VerticalPosition[keyof typeof VerticalPosition];

// @public
export const WeekdayFormat: {
Expand Down
22 changes: 11 additions & 11 deletions packages/web-components/fast-foundation/src/breadcrumb/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,17 +140,17 @@ This component is built with the expectation that focus is delegated to the anch

#### Fields

| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------- | ------- | -------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `download` | public | `string` | | Prompts the user to save the linked URL. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `href` | public | `string` | | The URL the hyperlink references. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `hreflang` | public | `string` | | Hints at the language of the referenced resource. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `ping` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `referrerpolicy` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `rel` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `target` | public | `"_self" or "_blank" or "_parent" or "_top"` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `type` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `control` | public | `HTMLAnchorElement` | | References the root element | FASTAnchor |
| Name | Privacy | Type | Default | Description | Inherited From |
| ---------------- | ------- | ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| `download` | public | `string` | | Prompts the user to save the linked URL. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `href` | public | `string` | | The URL the hyperlink references. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `hreflang` | public | `string` | | Hints at the language of the referenced resource. See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `ping` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `referrerpolicy` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `rel` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `target` | public | `AnchorTarget` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `type` | public | `string` | | See [`<a>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) for more information. | FASTAnchor |
| `control` | public | `HTMLAnchorElement` | | References the root element | FASTAnchor |

#### Attributes

Expand Down
30 changes: 20 additions & 10 deletions packages/web-components/fast-foundation/src/button/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,16 @@ This component is built with the expectation that focus is delegated to the butt



### Variables

| Name | Description | Type |
| ------------ | ------------------- | --------------------------------------------------------- |
| `ButtonType` | Button type values. | `{ submit: "submit", reset: "reset", button: "button", }` |

<hr/>



### class: `FASTButton`

#### Superclass
Expand All @@ -102,22 +112,22 @@ This component is built with the expectation that focus is delegated to the butt
| `formmethod` | public | `string` | | See [`<button>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button) for more details. | |
| `formnovalidate` | public | `boolean` | | See [`<button>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button) for more details. | |
| `formtarget` | public | `"_self" or "_blank" or "_parent" or "_top"` | | See [`<button>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button) for more details. | |
| `type` | public | `"submit" or "reset" or "button"` | | The button type. | |
| `type` | public | `ButtonType` | | The button type. | |
| `defaultSlottedContent` | public | `HTMLElement[]` | | Default slotted content | |
| `control` | public | `HTMLButtonElement` | | | |
| `proxy` | | | | | FormAssociatedButton |

#### Methods

| Name | Privacy | Description | Parameters | Return | Inherited From |
| ----------------------- | --------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------ | -------------- |
| `formactionChanged` | protected | | | `void` | |
| `formenctypeChanged` | protected | | | `void` | |
| `formmethodChanged` | protected | | | `void` | |
| `formnovalidateChanged` | protected | | | `void` | |
| `formtargetChanged` | protected | | | `void` | |
| `typeChanged` | protected | | `previous: "submit" or "reset" or "button" or void, next: "submit" or "reset" or "button"` | `void` | |
| `validate` | public | {@inheritDoc (FormAssociated:interface).validate} | | `void` | |
| Name | Privacy | Description | Parameters | Return | Inherited From |
| ----------------------- | --------- | ------------------------------------------------- | ----------------------------------------------------- | ------ | -------------- |
| `formactionChanged` | protected | | | `void` | |
| `formenctypeChanged` | protected | | | `void` | |
| `formmethodChanged` | protected | | | `void` | |
| `formnovalidateChanged` | protected | | | `void` | |
| `formtargetChanged` | protected | | | `void` | |
| `typeChanged` | protected | | `previous: ButtonType or undefined, next: ButtonType` | `void` | |
| `validate` | public | {@inheritDoc (FormAssociated:interface).validate} | | `void` | |

#### Attributes

Expand Down
Loading

0 comments on commit 8352248

Please sign in to comment.