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.

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

Add Component Slots to the Storefront Documentation #3319

Open
2 tasks
henrijoss opened this issue Jun 3, 2024 · 0 comments
Open
2 tasks

Add Component Slots to the Storefront Documentation #3319

henrijoss opened this issue Jun 3, 2024 · 0 comments
Labels
to be refined issue has to be refined

Comments

@henrijoss
Copy link
Contributor

henrijoss commented Jun 3, 2024

Scope

Add all available slots of a component to the Props tab documentation in the storefront.

Out of Scope

List topics that are not part of this task.

Notes

  • Necessary Included infos: name, description, isRequired + requiredTagName, hasAlternativeProp
  • Extend componentMeta and add SlotMeta type? Deprecate hasSlot, namedSlots and requiredNamedSlots
  • Maybe rename Props to something like API?
  • Maybe use the same format for slot documentation stencil supports for docs generation https://stenciljs.com/docs/docs-json#slots
    Example for p-flyout
/**
 * @slot header - Renders a sticky header section above the content area.
 * @slot - Default slot for the main content.
 * @slot footer - Shows a sticky footer section, flowing under the content area when scrollable.
 * @slot sub-footer - Shows a sub-footer section to display additional information below the footer. This slot is ideal for less critical content, such as legal information or FAQs, which provides further details to the user. It appears when scrolling to the end of the flyout or when there is available space to accommodate the content.
 */

Acceptance criteria

  • Criteria

Subtasks

  • Task
@henrijoss henrijoss added the to be refined issue has to be refined label Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
to be refined issue has to be refined
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant