Skip to main content
The Workspace Settings API is experimental and may change in the future. Please don’t use it in production versions of your app.
This component is returned by experimental_useWorkspaceSettingsForm().

​
Example

workspace-settings.tsx
import React from "react";
import { experimental_useWorkspaceSettingsForm } from "attio/client";
import type { App } from "attio";

export const workspaceSettings: App.Settings.Workspace = {
	Page,
};

function Page() {
	const { Form, TextInput, Section } = experimental_useWorkspaceSettingsForm();
	
	return (
		<Form>
			<Section title="General Settings" description="Configure basic app settings.">
				<TextInput label="Display name" name="display_name" />
				<TextInput label="Environment" name="environment" />
			</Section>
			<Section title="Webhook Settings">
				<TextInput label="Webhook URL" name="webhook_url" type="url" />
			</Section>
		</Form>
	);
}

​
Props

​
title
string
required
The title of the section. It will be displayed in a stronger font than the content of the section.
​
description
string
An optional description that provides additional context about the section.
​
children
React.ReactNode
required
The text (or components) content of the section.