Skip to main content
This page documents the legacy settings API, which is deprecated. It keeps working for existing apps, but new apps should define settings in src/app/settings/ instead; see Workspace settings. To convert an existing app, use the folder structure migration guide.
The useWorkspaceSettingsForm() hook creates a form for configuring workspace-level settings for your app. Unlike regular forms created with useForm(), workspace settings forms automatically save changes and don’t require an onSubmit handler.
Only workspace admins can edit workspace settings. However, all workspace members can view the settings.

Parameters

This hook takes no parameters. The schema is inferred globally based on your workspace settings configuration defined in app.settings.ts.

Returns

an object containing:

Components

The hook returns the following form components. Note that settings forms do not include a submit button, as changes are saved automatically.

Form Component

Input Components

Layout Components

Utility Components

  • <Button /> - Action buttons for additional functionality
  • <WithState /> - Access form state for conditional rendering

Example

workspace-settings.tsx