@streamoid/settings 0.12.2 → 0.12.3

package/dist/index.d.mts

@@ -1341,9 +1341,11 @@ interface SettingsContentProps {
     inviteRequested?: boolean;
     onInviteRequestHandled?: () => void;
     /**
-     * Leave settings. When supplied, the shell renders a close (×) button in the
-     * header and dismisses on Escape; the host decides where "closed" goes
-     * (settings is a full route in most hosts, not an overlay).
+     * Leave settings. Escape dismisses through it; the host decides where
+     * "closed" goes (settings is a full route in most hosts, not an overlay).
+     * In the default presentation the Back control falls back to it when no
+     * `onBack` is given; `presentation="overview-detail"` renders a close (×)
+     * button for it.
      *
      * Falls back to `adapters.navigation.close` so hosts that already build an
      * adapter object don't have to thread a second prop through. Omit both and
@@ -1351,14 +1353,18 @@ interface SettingsContentProps {
      */
     onClose?: () => void;
     /**
-     * @deprecated Ignored. Settings no longer renders a Back control: it is a
-     * top-level destination with one header row. To give users a way out, pass
-     * `onClose`, which renders a close (×) button and handles Escape. Kept so
-     * hosts that pass it keep compiling.
+     * Go back to the screen the user came from, rendered as a `← Back` control
+     * above the breadcrumb.
+     *
+     * Defaults to `adapters.navigation.back`, then to `onClose`, and to
+     * `window.history.back()` when none is supplied — settings is a route in every host, so the
+     * browser already knows where the user was, and requiring a prop would mean
+     * the control appeared in whichever app remembered to pass one. Pass `null`
+     * to render no back control.
      */
     onBack?: (() => void) | null;
 }
-declare function SettingsContent({ adapters, activeTab, onClose, hiddenApps, presentation, showOverview, onOverview, onInvitePeople, inviteRequested, onInviteRequestHandled, }: SettingsContentProps): react.JSX.Element;
+declare function SettingsContent({ adapters, activeTab, onClose, onBack, hiddenApps, presentation, showOverview, onOverview, onInvitePeople, inviteRequested, onInviteRequestHandled, }: SettingsContentProps): react.JSX.Element;
 
 interface WorkspaceData {
     id: string;

package/dist/index.d.ts

@@ -1341,9 +1341,11 @@ interface SettingsContentProps {
     inviteRequested?: boolean;
     onInviteRequestHandled?: () => void;
     /**
-     * Leave settings. When supplied, the shell renders a close (×) button in the
-     * header and dismisses on Escape; the host decides where "closed" goes
-     * (settings is a full route in most hosts, not an overlay).
+     * Leave settings. Escape dismisses through it; the host decides where
+     * "closed" goes (settings is a full route in most hosts, not an overlay).
+     * In the default presentation the Back control falls back to it when no
+     * `onBack` is given; `presentation="overview-detail"` renders a close (×)
+     * button for it.
      *
      * Falls back to `adapters.navigation.close` so hosts that already build an
      * adapter object don't have to thread a second prop through. Omit both and
@@ -1351,14 +1353,18 @@ interface SettingsContentProps {
      */
     onClose?: () => void;
     /**
-     * @deprecated Ignored. Settings no longer renders a Back control: it is a
-     * top-level destination with one header row. To give users a way out, pass
-     * `onClose`, which renders a close (×) button and handles Escape. Kept so
-     * hosts that pass it keep compiling.
+     * Go back to the screen the user came from, rendered as a `← Back` control
+     * above the breadcrumb.
+     *
+     * Defaults to `adapters.navigation.back`, then to `onClose`, and to
+     * `window.history.back()` when none is supplied — settings is a route in every host, so the
+     * browser already knows where the user was, and requiring a prop would mean
+     * the control appeared in whichever app remembered to pass one. Pass `null`
+     * to render no back control.
      */
     onBack?: (() => void) | null;
 }
-declare function SettingsContent({ adapters, activeTab, onClose, hiddenApps, presentation, showOverview, onOverview, onInvitePeople, inviteRequested, onInviteRequestHandled, }: SettingsContentProps): react.JSX.Element;
+declare function SettingsContent({ adapters, activeTab, onClose, onBack, hiddenApps, presentation, showOverview, onOverview, onInvitePeople, inviteRequested, onInviteRequestHandled, }: SettingsContentProps): react.JSX.Element;
 
 interface WorkspaceData {
     id: string;