diff --git a/react/src/components/SlotContainer.tsx b/react/src/components/SlotContainer.tsx index 87d76b1..3ccb1fa 100644 --- a/react/src/components/SlotContainer.tsx +++ b/react/src/components/SlotContainer.tsx @@ -6,6 +6,7 @@ import * as React from 'react'; * See {@link @theoplayer/web-ui!SlotContainer | SlotContainer in @theoplayer/web-ui}. * * @group Components + * @internal */ export const SlotContainer = createComponent({ tagName: 'theoplayer-slot-container', diff --git a/src/components/SlotContainer.ts b/src/components/SlotContainer.ts index a139673..97acb05 100644 --- a/src/components/SlotContainer.ts +++ b/src/components/SlotContainer.ts @@ -3,6 +3,21 @@ import slotContainerCss from './SlotContainer.css'; const template = createTemplate('theoplayer-slot-container', ``); +/** + * `` - A container that can be assigned to a slot, + * and behaves as if all its children are directly assigned to that slot. + * + * This behaves approximately like a regular `
` with style `display: contents`, + * but receives some special treatment from e.g. {@link MenuGroup | ``} + * which normally expects its {@link Menu | menu}s to be slotted in as direct children. + * Those menus can also be children of a `` instead. + * + * This is an internal component, used mainly by Open Video UI for React. + * You shouldn't need this under normal circumstances. + * + * @group Components + * @internal + */ export class SlotContainer extends HTMLElement { constructor() { super();