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

feat: add slot event part docs to foundation #5912

Merged
merged 12 commits into from
May 2, 2022
Merged

feat: add slot event part docs to foundation #5912

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
460897f
add docs for accordion through breadcrumb-item
chrisdholt Apr 28, 2022
0f27b29
update through listbox option
chrisdholt Apr 28, 2022
f16ca5f
updates through search
chrisdholt Apr 28, 2022
8d02019
add select and skeleton
chrisdholt Apr 28, 2022
880d066
add update through text-area
chrisdholt Apr 28, 2022
cec7e6c
add initial jsdocs for foundation elements
chrisdholt Apr 28, 2022
6322263
update docs
chrisdholt Apr 28, 2022
c92f630
Change files
chrisdholt Apr 28, 2022
b242583
fix: add custom tags to tsdoc (#5920)
williamw2 Apr 29, 2022
a78bb50
fix misspelled part and incorrect syntax for non-default slots
chrisdholt May 2, 2022
bf02e13
fix missing tsdoc in components
chrisdholt May 2, 2022
490e6ee
Change files
chrisdholt May 2, 2022
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
Next Next commit
add docs for accordion through breadcrumb-item
  • Loading branch information
@chrisdholt
chrisdholt committed May 2, 2022
commit 460897f4a38ada5ff305350e149091f14c16d8d7
16 changes: 16 additions & 0 deletions packages/web-components/fast-foundation/src/accordion-item/accordion-item.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,22 @@ export type AccordionItemOptions = FoundationElementDefinition &

/**
* An individual item in an {@link @microsoft/fast-foundation#(Accordion:class) }.
*
* @slot start - Content which can be provided between the heading and the icon
* @slot end - Content which can be provided between the start slot and icon
* @slot heading - Content which serves as the accordion item heading and text of the expand button
* @slot - The default slot for accordion item content
* @slot - expanded-icon - The expanded icon
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The analyzer uses the hyphen as the separator between the name and the description. These hyphens between @slot and the name should be removed.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I did almost all of these manually, I'll do one last check for any time it's not the default slot.

* @slot - collapsed-icon - The collapsed icon
* @fires change - Fires a custom 'change' event when the button is invoked
* @csspart heading - Wraps the button
* @csspart button - The button which serves to invoke the item
* @csspart heading-content - Wraps the slot for the heading content within the button
* @csspart icon - The icon container
* @csspart expanded-icon - The expanded icon slot
* @csspart collapsed-icon - The collapsed icon
* @csspart region - The wrapper for the accordion item content
*
* @public
*/
export class AccordionItem extends FoundationElement {
Expand Down
3 changes: 3 additions & 0 deletions packages/web-components/fast-foundation/src/accordion/accordion.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ export enum AccordionExpandMode {
/**
* An Accordion Custom HTML Element
* Implements {@link https://www.w3.org/TR/wai-aria-practices-1.1/#accordion | ARIA Accordion}.
*
* @fires change - Fires a custom 'change' event when the active item changes
* @csspart item - The slot for the accordion items
* @public
*
* @remarks
Expand Down
6 changes: 6 additions & 0 deletions packages/web-components/fast-foundation/src/anchor/anchor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ export type AnchorOptions = FoundationElementDefinition & StartEndOptions;
* An Anchor Custom HTML Element.
* Based largely on the {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a | <a> element }.
*
* @slot start - Content which can be provided before the button content
* @slot end - Content which can be provided after the button content
* @slot - The default slot for accordion item content
* @csspart control - The anchor element
* @csspart content - The button content
*
* @public
*/
export class Anchor extends FoundationElement {
Expand Down
4 changes: 4 additions & 0 deletions packages/web-components/fast-foundation/src/anchored-region/anchored-region.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,10 @@ interface Dimension {
/**
* An anchored region Custom HTML Element.
*
* @slot - The default slot for the content
* @fires loaded - Fires a custom 'loaded' event when the region is loaded and visible
* @fires positionchange - Fires a custom 'positionchange' event when the position has changed
*
* @public
*/
export class AnchoredRegion extends FoundationElement {
Expand Down
8 changes: 8 additions & 0 deletions packages/web-components/fast-foundation/src/avatar/avatar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ export type AvatarOptions = FoundationElementDefinition & {
/**
* An Avatar Custom HTML Element
*
* @slot media - Used for media such as an image
* @slot - The default slot for avatar text, commonly a name or initials
* @slot badge - Used to provide a badge, such as a status badge
* @csspart backplate - The wrapping container for the avatar
* @csspart link - The avatar link
* @csspart media - The media slot
* @csspart content - The default slot
*
* @public
*/
export class Avatar extends FoundationElement {
Expand Down
2 changes: 2 additions & 0 deletions packages/web-components/fast-foundation/src/badge/badge.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ import { FoundationElement } from "../foundation-element/foundation-element.js";

/**
* A Badge Custom HTML Element.
* @slot - The default slot for the badge
* @csspart control - The element representing the badge, which wraps the default slot
*
* @public
*/
Expand Down
6 changes: 6 additions & 0 deletions packages/web-components/fast-foundation/src/breadcrumb-item/breadcrumb-item.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import { applyMixins } from "../utilities/apply-mixins.js";

/**
* Breadcrumb Item configuration options
*
* @slot - The default slot for when no href is provided or for providing your own custom elements
* @slot separator - The slot for providing a custom separator
* @csspart listitem - The wrapping container for the item, represents a semantic listitem
* @csspart separator - The wrapping element for the separator
*
* @public
*/
export type BreadcrumbItemOptions = FoundationElementDefinition &
Expand Down
2 changes: 2 additions & 0 deletions packages/web-components/fast-foundation/src/breadcrumb/breadcrumb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { FoundationElement } from "../foundation-element/foundation-element.js";

/**
* A Breadcrumb Custom HTML Element.
* @slot - The default slot for the breadcrumb items
* @csspart list - The element wrapping the slotted items
*
* @public
*/
Expand Down