docs: ensure *.Portal subcomponents are documented (#1397)

Author: huntabyte

.changeset/stale-toys-promise.md

@@ -0,0 +1,5 @@
+---
+"bits-ui": patch
+---
+
+chore(Popover): export `PopoverPortalPropsWithoutHTML` from Popover types

docs/src/lib/content/api-reference/combobox.api.ts

@@ -6,6 +6,7 @@ import type {
 	ComboboxGroupPropsWithoutHTML,
 	ComboboxInputPropsWithoutHTML,
 	ComboboxItemPropsWithoutHTML,
+	ComboboxPortalPropsWithoutHTML,
 	ComboboxRootPropsWithoutHTML,
 	ComboboxTriggerPropsWithoutHTML,
 } from "bits-ui";
@@ -41,6 +42,7 @@ import {
 	floatingProps,
 	focusScopeProps,
 	forceMountProp,
+	portalProps,
 	preventOverflowTextSelectionProp,
 	preventScrollProp,
 	withChildProps,
@@ -357,11 +359,19 @@ export const arrow = createApiSchema<ComboboxArrowPropsWithoutHTML>({
 	],
 });
 
+export const portal = createApiSchema<ComboboxPortalPropsWithoutHTML>({
+	title: "Portal",
+	description:
+		"When used, will render the combobox content into the body or custom `to` element when open",
+	props: portalProps,
+});
+
 export const combobox = [
 	root,
 	trigger,
 	content,
 	contentStatic,
+	portal,
 	item,
 	input,
 	group,

docs/src/lib/content/api-reference/date-picker.api.ts

@@ -32,7 +32,7 @@ import {
 	createPropSchema,
 	withChildProps,
 } from "./helpers.js";
-import { content, trigger } from "./popover.api.js";
+import { content, portal, trigger } from "./popover.api.js";
 import { OnOpenChangeProp } from "./extended-types/shared/index.js";
 import * as C from "$lib/content/constants.js";
 
@@ -158,6 +158,7 @@ export const datePicker = [
 	segment,
 	trigger,
 	content,
+	portal,
 	calendar,
 	header,
 	prevButton,

docs/src/lib/content/api-reference/date-range-picker.api.ts

@@ -11,7 +11,7 @@ import {
 	createEnumProp,
 	withChildProps,
 } from "./helpers.js";
-import { content, trigger } from "./popover.api.js";
+import { content, portal, trigger } from "./popover.api.js";
 import {
 	root as calendarRoot,
 	cell,
@@ -155,6 +155,7 @@ export const dateRangePicker = [
 	segment,
 	trigger,
 	content,
+	portal,
 	calendar,
 	header,
 	prevButton,

docs/src/lib/content/api-reference/helpers.ts

@@ -240,7 +240,7 @@ export const portalProps = {
 	to: createUnionProp({
 		definition: PortalToProp,
 		options: ["string", "HTMLElement", "null", "undefined"],
-		description: `Where to render the content when it is open. Defaults to the body. Can be disabled by passing \`null\``,
+		description: `Where to render the content when it is open. Defaults to the body. Can be disabled by passing \`null\`.`,
 		default: "body",
 	}),
 	disabled: createBooleanProp({

docs/src/lib/content/api-reference/link-preview.api.ts

@@ -2,6 +2,7 @@ import type {
 	LinkPreviewArrowPropsWithoutHTML,
 	LinkPreviewContentPropsWithoutHTML,
 	LinkPreviewContentStaticPropsWithoutHTML,
+	LinkPreviewPortalPropsWithoutHTML,
 	LinkPreviewRootPropsWithoutHTML,
 	LinkPreviewTriggerPropsWithoutHTML,
 } from "bits-ui";
@@ -22,6 +23,7 @@ import {
 	floatingProps,
 	focusScopeProps,
 	forceMountProp,
+	portalProps,
 	withChildProps,
 } from "$lib/content/api-reference/helpers.js";
 import * as C from "$lib/content/constants.js";
@@ -159,4 +161,11 @@ export const arrow = createApiSchema<LinkPreviewArrowPropsWithoutHTML>({
 	],
 });
 
-export const linkPreview = [root, trigger, content, contentStatic, arrow];
+const portal = createApiSchema<LinkPreviewPortalPropsWithoutHTML>({
+	title: "Portal",
+	description:
+		"When used, will render the link preview content into the body or custom `to` element when open",
+	props: portalProps,
+});
+
+export const linkPreview = [root, trigger, content, contentStatic, arrow, portal];

docs/src/lib/content/api-reference/popover.api.ts

@@ -3,6 +3,7 @@ import type {
 	PopoverClosePropsWithoutHTML,
 	PopoverContentPropsWithoutHTML,
 	PopoverContentStaticPropsWithoutHTML,
+	PopoverPortalPropsWithoutHTML,
 	PopoverRootPropsWithoutHTML,
 	PopoverTriggerPropsWithoutHTML,
 } from "bits-ui";
@@ -23,6 +24,7 @@ import {
 	floatingProps,
 	focusScopeProps,
 	forceMountProp,
+	portalProps,
 	preventOverflowTextSelectionProp,
 	preventScrollProp,
 	withChildProps,
@@ -170,4 +172,11 @@ export const arrow = createApiSchema<PopoverArrowPropsWithoutHTML>({
 	],
 });
 
-export const popover = [root, trigger, content, contentStatic, close, arrow];
+export const portal = createApiSchema<PopoverPortalPropsWithoutHTML>({
+	title: "Portal",
+	description:
+		"When used, will render the popover content into the body or custom `to` element when open",
+	props: portalProps,
+});
+
+export const popover = [root, trigger, content, contentStatic, close, arrow, portal];

docs/src/lib/content/api-reference/select.api.ts

@@ -17,6 +17,7 @@ import {
 	floatingProps,
 	focusScopeProps,
 	forceMountProp,
+	portalProps,
 	preventOverflowTextSelectionProp,
 	preventScrollProp,
 	withChildProps,
@@ -29,6 +30,7 @@ import type {
 	SelectGroupHeadingPropsWithoutHTML,
 	SelectGroupPropsWithoutHTML,
 	SelectItemPropsWithoutHTML,
+	SelectPortalPropsWithoutHTML,
 	SelectRootPropsWithoutHTML,
 	SelectScrollDownButtonPropsWithoutHTML,
 	SelectScrollUpButtonPropsWithoutHTML,
@@ -371,11 +373,19 @@ export const arrow = createApiSchema<SelectArrowPropsWithoutHTML>({
 	],
 });
 
+export const portal = createApiSchema<SelectPortalPropsWithoutHTML>({
+	title: "Portal",
+	description:
+		"When used, will render the select content into the body or custom `to` element when open",
+	props: portalProps,
+});
+
 export const select = [
 	root,
 	trigger,
 	content,
 	contentStatic,
+	portal,
 	item,
 	viewport,
 	scrollUpButton,

docs/src/lib/content/api-reference/tooltip.api.ts

@@ -2,6 +2,7 @@ import type {
 	TooltipArrowPropsWithoutHTML,
 	TooltipContentPropsWithoutHTML,
 	TooltipContentStaticPropsWithoutHTML,
+	TooltipPortalPropsWithoutHTML,
 	TooltipProviderPropsWithoutHTML,
 	TooltipRootPropsWithoutHTML,
 	TooltipTriggerPropsWithoutHTML,
@@ -27,6 +28,7 @@ import {
 	escapeLayerProps,
 	floatingProps,
 	forceMountProp,
+	portalProps,
 	withChildProps,
 } from "$lib/content/api-reference/helpers.js";
 import * as C from "$lib/content/constants.js";
@@ -221,4 +223,11 @@ export const arrow = createApiSchema<TooltipArrowPropsWithoutHTML>({
 	],
 });
 
-export const tooltip = [provider, root, trigger, content, contentStatic, arrow];
+const portal = createApiSchema<TooltipPortalPropsWithoutHTML>({
+	title: "Portal",
+	description:
+		"When used, will render the tooltip content into the body or custom `to` element when open",
+	props: portalProps,
+});
+
+export const tooltip = [provider, root, trigger, content, contentStatic, arrow, portal];

packages/bits-ui/src/lib/bits/popover/exports.ts

@@ -13,6 +13,5 @@ export type {
 	PopoverContentStaticProps as ContentStaticProps,
 	PopoverTriggerProps as TriggerProps,
 	PopoverCloseProps as CloseProps,
+	PopoverPortalProps as PortalProps,
 } from "./types.js";
-
-export type { PortalProps } from "$lib/bits/utilities/portal/types.js";

packages/bits-ui/src/lib/bits/popover/types.ts

@@ -12,6 +12,7 @@ import type {
 	BitsPrimitiveDivAttributes,
 } from "$lib/shared/attributes.js";
 import type { FloatingContentSnippetProps, StaticContentSnippetProps } from "$lib/shared/types.js";
+import type { PortalProps } from "$lib/types.js";
 
 export type PopoverRootPropsWithoutHTML = WithChildren<{
 	/**
@@ -56,3 +57,6 @@ export type PopoverCloseProps = PopoverClosePropsWithoutHTML &
 export type PopoverArrowPropsWithoutHTML = ArrowPropsWithoutHTML;
 
 export type PopoverArrowProps = ArrowProps;
+
+export type PopoverPortalPropsWithoutHTML = PortalProps;
+export type PopoverPortalProps = PortalProps;