docs(mosaic): document the profile page, select group and organization panel exports

Author: alexcarpenter

packages/mosaic/src/features/organization-profile/organization-profile.tsx

@@ -112,6 +112,10 @@ export function OrganizationProfile({
   );
 }
 
+/**
+ * The organization's built-in panels, for the pages the instance has turned on. `apiKeysProps.hide`
+ * leaves the API keys panel out; the rest of `apiKeysProps` goes to it.
+ */
 export function organizationProfilePanels(
   available: readonly OrganizationProfilePageId[],
   { hide: hideAPIKeys = false, ...apiKeysProps }: APIKeysPageProps = {},

packages/mosaic/src/features/organization-profile/organization-profile.view.tsx

@@ -16,9 +16,16 @@ import type {
   OrganizationProfilePages,
 } from './organization-profile.types';
 
+/** What the organization's navigation is built from. */
 export interface OrganizationProfilePageListOptions {
+  /** The built-in pages. One left undefined is left out of the navigation. */
   pages: OrganizationProfilePages;
+  /** Pages of the consumer's own, added to the navigation after the built-ins. */
   customPages?: readonly CustomOrganizationProfilePage[];
+  /**
+   * The order the navigation runs in, by id: a built-in page's id, or a custom page's `path`. Ids
+   * left out keep their default place behind the ones named.
+   */
   pageOrder?: readonly (OrganizationProfilePageId | (string & {}))[];
 }
 

packages/mosaic/src/features/profile-pages/profile-pages.view.tsx

@@ -21,9 +21,11 @@ export interface ProfilePageGroup {
 export interface ProfilePagesViewProps extends Omit<ProfileRootProps, 'children' | 'value' | 'onValueChange'> {
   /** Names the surface, and the dialog it opens in. */
   label: string;
+  /** The navigation, in order. A group without a label lists its pages without a heading. */
   groups: readonly ProfilePageGroup[];
   /** The open page's id. One the navigation does not list opens the first page instead. */
   activePage: string;
+  /** Called with a page's id when the user picks it from the navigation. */
   onPageChange: (page: string) => void;
 }
 

packages/mosaic/src/primitives/select/select-group.tsx

@@ -8,6 +8,7 @@ const SelectGroupContext = createContext<string | undefined>(undefined);
 
 export type SelectGroupProps = ComponentProps<'div'>;
 
+/** A labelled set of options in the listbox, named by the `Select.GroupLabel` inside it. */
 export function SelectGroup(props: SelectGroupProps) {
   const { render, ...otherProps } = props;
   const labelId = useId();
@@ -30,6 +31,7 @@ export function SelectGroup(props: SelectGroupProps) {
 
 export type SelectGroupLabelProps = ComponentProps<'div'>;
 
+/** Names the `Select.Group` it sits in. Throws outside one. */
 export function SelectGroupLabel(props: SelectGroupLabelProps) {
   const { render, ...otherProps } = props;
   const labelId = useContext(SelectGroupContext);