Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

chore: migrate `<Toggle>` to `<Switch>` (#45314)

Gildas Garciaa5b36d91deeb
diff --git a/apps/lite-studio/app/routes/projects.$ref.tsx b/apps/lite-studio/app/routes/projects.$ref.tsx
index 8ef6b0fc6c6..093092cc0f3 100644
--- a/apps/lite-studio/app/routes/projects.$ref.tsx
+++ b/apps/lite-studio/app/routes/projects.$ref.tsx
@@ -8,11 +8,11 @@ import {
Input,
Label_Shadcn_ as Label,
Separator,
+ Switch,
Tabs_Shadcn_ as Tabs,
TabsContent_Shadcn_ as TabsContent,
TabsList_Shadcn_ as TabsList,
TabsTrigger_Shadcn_ as TabsTrigger,
- Toggle,
} from 'ui'
import { Admonition } from 'ui-patterns/admonition'
import {
@@ -150,9 +150,13 @@ export default function ProjectPage() {
/>
</div>
- <div className="flex items-center gap-3">
- <Toggle checked={enableRls} onChange={() => setEnableRls(!enableRls)} />
- <Label>Enable RLS by default on new tables</Label>
+ <div className="flex items-center space-x-2">
+ <Switch
+ id="enable-rls"
+ checked={enableRls}
+ onCheckedChange={(checked) => setEnableRls(checked)}
+ />
+ <Label htmlFor="enable-rls">Enable RLS by default on new tables</Label>
</div>
<div className="flex items-center gap-3">
diff --git a/apps/studio/components/interfaces/Database/Extensions/ExtensionCardSkeleton.tsx b/apps/studio/components/interfaces/Database/Extensions/ExtensionCardSkeleton.tsx
index 85c57d7d6f5..5ec45241d40 100644
--- a/apps/studio/components/interfaces/Database/Extensions/ExtensionCardSkeleton.tsx
+++ b/apps/studio/components/interfaces/Database/Extensions/ExtensionCardSkeleton.tsx
@@ -1,4 +1,4 @@
-import { Toggle } from 'ui'
+import { Switch } from 'ui'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
export interface ExtensionCardSkeletonProps {
@@ -15,7 +15,7 @@ const ExtensionCardSkeleton = ({ index = 0 }: ExtensionCardSkeletonProps) => {
</div>
</div>
- <Toggle size="tiny" checked={false} disabled={true} />
+ <Switch checked={false} disabled={true} />
</div>
<div className="bg-panel-header-light bg-panel-secondary-light flex h-full flex-col justify-between">
<div className="py-3 px-4">
diff --git a/apps/studio/components/interfaces/Database/Functions/CreateFunction/index.tsx b/apps/studio/components/interfaces/Database/Functions/CreateFunction/index.tsx
index 70f234eafb5..845fbe42b23 100644
--- a/apps/studio/components/interfaces/Database/Functions/CreateFunction/index.tsx
+++ b/apps/studio/components/interfaces/Database/Functions/CreateFunction/index.tsx
@@ -28,7 +28,7 @@ import {
SheetContent,
SheetFooter,
SheetSection,
- Toggle,
+ Switch,
} from 'ui'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import z from 'zod'
@@ -288,12 +288,20 @@ export const CreateFunction = ({
<>
<SheetSection className={focusedEditor ? 'hidden' : ''}>
<div className="space-y-8 rounded bg-studio py-4 px-6 border border-overlay">
- <Toggle
- onChange={() => setAdvancedSettingsShown(!advancedSettingsShown)}
- label="Show advanced settings"
- checked={advancedSettingsShown}
- labelOptional="These are settings that might be familiar for Postgres developers"
- />
+ <FormItem className="flex flex-row items-center justify-between">
+ <div className="space-y-0.5">
+ <FormLabel className="text-base">Show advanced settings</FormLabel>
+ <FormDescription>
+ These are settings that might be familiar for Postgres developers
+ </FormDescription>
+ </div>
+ <FormControl>
+ <Switch
+ checked={advancedSettingsShown}
+ onCheckedChange={(checked) => setAdvancedSettingsShown(checked)}
+ />
+ </FormControl>
+ </FormItem>
</div>
</SheetSection>
{advancedSettingsShown && (
diff --git a/apps/studio/components/interfaces/Realtime/Inspector/RealtimeFilterPopover/index.tsx b/apps/studio/components/interfaces/Realtime/Inspector/RealtimeFilterPopover/index.tsx
index 82f69e962cf..6e58d8389a3 100644
--- a/apps/studio/components/interfaces/Realtime/Inspector/RealtimeFilterPopover/index.tsx
+++ b/apps/studio/components/interfaces/Realtime/Inspector/RealtimeFilterPopover/index.tsx
@@ -13,7 +13,7 @@ import {
Popover_Shadcn_,
PopoverContent_Shadcn_,
PopoverTrigger_Shadcn_,
- Toggle,
+ Switch,
} from 'ui'
import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
@@ -102,12 +102,12 @@ export const RealtimeFilterPopover = ({ config, onChangeConfig }: RealtimeFilter
Presence
</label>
</div>
- <Toggle
+ <Switch
id="toggle-presence"
- size="tiny"
+ size="small"
checked={tempConfig.enablePresence}
- onChange={() =>
- setTempConfig({ ...tempConfig, enablePresence: !tempConfig.enablePresence })
+ onCheckedChange={(checked) =>
+ setTempConfig((current) => ({ ...current, enablePresence: checked }))
}
/>
</div>
@@ -126,12 +126,12 @@ export const RealtimeFilterPopover = ({ config, onChangeConfig }: RealtimeFilter
Broadcast
</label>
</div>
- <Toggle
+ <Switch
id="toggle-broadcast"
- size="tiny"
+ size="small"
checked={tempConfig.enableBroadcast}
- onChange={() =>
- setTempConfig({ ...tempConfig, enableBroadcast: !tempConfig.enableBroadcast })
+ onCheckedChange={(checked) =>
+ setTempConfig((current) => ({ ...current, enableBroadcast: checked }))
}
/>
</div>
@@ -156,13 +156,13 @@ export const RealtimeFilterPopover = ({ config, onChangeConfig }: RealtimeFilter
Database changes
</label>
</div>
- <Toggle
+ <Switch
id="toggle-db-changes"
- size="tiny"
+ size="small"
checked={tempConfig.enableDbChanges}
disabled={!config.enableDbChanges}
- onChange={() =>
- setTempConfig({ ...tempConfig, enableDbChanges: !tempConfig.enableDbChanges })
+ onCheckedChange={(checked) =>
+ setTempConfig((current) => ({ ...current, enableDbChanges: checked }))
}
/>
</div>
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/RowEditor/RowEditor.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/RowEditor/RowEditor.tsx
index 6b07a2ec525..2ad7f3b2812 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/RowEditor/RowEditor.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/RowEditor/RowEditor.tsx
@@ -1,7 +1,7 @@
import type { PostgresTable } from '@supabase/postgres-meta'
import { isEmpty, noop, partition } from 'lodash'
import { useEffect, useMemo, useState } from 'react'
-import { SidePanel, Toggle } from 'ui'
+import { Label_Shadcn_, SidePanel, Switch } from 'ui'
import { ActionBar } from '../ActionBar'
import { formatForeignKeys } from '../ForeignKeySelector/ForeignKeySelector.utils'
@@ -192,18 +192,14 @@ export const RowEditor = ({
visible={visible}
>
{isNewRecord && editable && (
- <div className="flex items-center gap-x-2">
- <Toggle
- size="tiny"
+ <div className="flex items-center space-x-2">
+ <Switch
+ id="create-more"
+ size="small"
checked={createMore}
- onChange={() => setCreateMore(!createMore)}
+ onCheckedChange={(checked) => setCreateMore(checked)}
/>
- <label
- className="text-foreground-light text-sm cursor-pointer select-none"
- onClick={() => setCreateMore(!createMore)}
- >
- Create more
- </label>
+ <Label_Shadcn_ htmlFor="create-more">Create more</Label_Shadcn_>
</div>
)}
</ActionBar>
diff --git a/packages/ui-patterns/src/PrivacySettings/index.tsx b/packages/ui-patterns/src/PrivacySettings/index.tsx
index 8ed693d7ee7..8a3e5461f6f 100644
--- a/packages/ui-patterns/src/PrivacySettings/index.tsx
+++ b/packages/ui-patterns/src/PrivacySettings/index.tsx
@@ -3,7 +3,7 @@
import { useConsentState } from 'common'
import Link from 'next/link'
import { PropsWithChildren, useState } from 'react'
-import { Modal, Toggle } from 'ui'
+import { Label_Shadcn_, Modal, Switch } from 'ui'
import { Admonition } from '../admonition'
@@ -65,7 +65,7 @@ export const PrivacySettings = ({
className="max-w-[calc(100vw-4rem)]"
size="medium"
>
- <div className="pt-3 divide-y divide-border">
+ <div className="divide-y divide-border">
{categories === null ? (
<Modal.Content>
<Admonition
@@ -135,14 +135,12 @@ function Category({
return (
<Modal.Content key={category.slug}>
- <Toggle
- checked={isChecked}
- defaultChecked={isChecked}
- disabled={category.isEssential}
- onChange={handleChange}
- label={category.label}
- descriptionText={
- <>
+ <div className="flex flex-row items-center justify-between gap-4">
+ <div className="space-y-0.5">
+ <Label_Shadcn_ className="text-base" htmlFor={category.slug}>
+ {category.label}
+ </Label_Shadcn_>
+ <div className="text-sm text-foreground-light" id={`${category.slug}-description`}>
{category.description}
<br />
<Link
@@ -151,9 +149,17 @@ function Category({
>
Learn more
</Link>
- </>
- }
- />
+ </div>
+ </div>
+ <Switch
+ id={category.slug}
+ checked={isChecked}
+ disabled={category.isEssential}
+ defaultChecked={isChecked}
+ onCheckedChange={handleChange}
+ aria-describedby={`${category.slug}-description`}
+ />
+ </div>
</Modal.Content>
)
}
diff --git a/packages/ui/index.tsx b/packages/ui/index.tsx
index 0c0058cc0f3..1e2c20d7751 100644
--- a/packages/ui/index.tsx
+++ b/packages/ui/index.tsx
@@ -37,7 +37,6 @@ export * from './src/lib/utils'
// DATA ENTRY
export * from './src/components/Input'
-export * from './src/components/Toggle'
export * from './src/components/ExpandingTextArea'
// layout
diff --git a/packages/ui/src/components/Toggle/Toggle.module.css b/packages/ui/src/components/Toggle/Toggle.module.css
deleted file mode 100644
index 190ff6b62c8..00000000000
--- a/packages/ui/src/components/Toggle/Toggle.module.css
+++ /dev/null
@@ -1,69 +0,0 @@
-/* .sbui-toggle {
- @apply p-0 relative inline-flex shrink-0 h-6 w-11 border-2 border-transparent rounded-full cursor-pointer;
- @apply transition-colors ease-in-out duration-200;
- @apply focus:outline-none bg-200 dark:bg-gray-400;
-}
-
-.sbui-toggle--active {
- @apply bg-brand-600;
- @apply dark:bg-brand-600;
-}
-
-.sbui-toggle__handle {
- @apply inline-block h-5 w-5 rounded-full bg-white shadow transform ring-0 transition ease-in-out duration-200 translate-x-0;
-}
-
-.sbui-toggle__handle--active {
- @apply translate-x-5;
-}
-
-.sbui-toggle:disabled {
- @apply opacity-75 cursor-not-allowed;
- pointer-events: none;
-} */
-
-/*
- Toggle sizes
-*/
-
-/* tiny */
-
-/* .sbui-toggle--tiny {
- @apply h-4 w-7;
-}
-.sbui-toggle--tiny .sbui-toggle__handle {
- @apply h-3 w-3;
-}
-.sbui-toggle--tiny .sbui-toggle__handle--active {
- @apply translate-x-3;
-} */
-
-/* small and medium */
-
-/* .sbui-toggle--small,
-.sbui-toggle--medium {
- @apply h-6 w-11;
-}
-.sbui-toggle--small .sbui-toggle__handle,
-.sbui-toggle--medium .sbui-toggle__handle {
- @apply h-5 w-5;
-}
-.sbui-toggle--small .sbui-toggle__handle--active,
-.sbui-toggle--medium .sbui-toggle__handle--active {
- @apply translate-x-5;
-} */
-
-/* large and xlarge */
-
-/* .sbui-toggle--large,
-.sbui-toggle--xlarge {
- @apply h-7 w-12;
-}
-.sbui-toggle--large .sbui-toggle__handle,
-.sbui-toggle--xlarge .sbui-toggle__handle {
- @apply h-6 w-6;
-}
-.sbui-toggle--large .sbui-toggle__handle--active,
-.sbui-toggle--xlarge .sbui-toggle__handle--active {
- @apply translate-x-5;
-} */
diff --git a/packages/ui/src/components/Toggle/Toggle.tsx b/packages/ui/src/components/Toggle/Toggle.tsx
deleted file mode 100644
index f1e9011394f..00000000000
--- a/packages/ui/src/components/Toggle/Toggle.tsx
+++ /dev/null
@@ -1,107 +0,0 @@
-'use client'
-
-import clsx from 'clsx'
-import React, { useEffect, useState } from 'react'
-
-import { FormLayout } from '../../lib/Layout/FormLayout/FormLayout'
-import styleHandler from '../../lib/theme/styleHandler'
-
-interface Props extends Omit<React.HTMLAttributes<HTMLButtonElement>, 'size'> {
- name?: string
- disabled?: boolean
- layout?: 'horizontal' | 'vertical' | 'flex'
- error?: string
- descriptionText?: string | React.ReactNode
- label?: string | React.ReactNode
- afterLabel?: string | React.ReactNode
- beforeLabel?: string
- labelOptional?: string
- className?: any
- defaultChecked?: boolean
- checked?: boolean
- align?: 'right' | 'left'
- size?: 'tiny' | 'small' | 'medium' | 'large' | 'xlarge'
- labelLayout?: 'horizontal' | 'vertical'
-}
-
-/**
- * @deprecated Use `import { Switch } from "ui"` instead
- */
-function Toggle({
- disabled,
- id = '',
- name = '',
- layout = 'flex',
- error,
- descriptionText,
- label,
- afterLabel,
- beforeLabel,
- labelOptional,
- onChange,
- defaultChecked,
- checked,
- className,
- align = 'left',
- size = 'medium',
- labelLayout,
- ...props
-}: Props) {
- const __styles = styleHandler('toggle')
- const [intChecked, setIntChecked] = useState((defaultChecked || checked) ?? false)
-
- // check if toggle checked is true or false
- // if neither true or false the toggle will rely on component state internally
- const active = checked ?? intChecked
-
- useEffect(() => {
- setIntChecked(active)
- }, [])
-
- function onClick() {
- // '`onChange` callback for this component
-
- // @ts-ignore // issue with conflicting input/button tag being used
- if (onChange) onChange(!active)
-
- setIntChecked(!intChecked)
- }
-
- let toggleClasses = [__styles.base, __styles.handle_container[size]]
- if (active) toggleClasses.push(__styles.active)
-
- let handleClasses = [__styles.handle['base'], __styles.handle[size]]
- if (active) handleClasses.push(__styles.handle_active[size])
-
- return (
- <FormLayout
- className={className}
- label={label}
- afterLabel={afterLabel}
- beforeLabel={beforeLabel}
- labelOptional={labelOptional}
- layout={layout}
- id={id}
- error={error}
- align={align}
- descriptionText={descriptionText}
- size={size}
- labelLayout={labelLayout}
- nonBoxInput
- >
- <button
- type="button"
- id={id}
- name={name}
- className={clsx(...toggleClasses, disabled && 'opacity-50 cursor-default')}
- onClick={onClick}
- disabled={disabled}
- {...props}
- >
- <span aria-hidden="true" className={handleClasses.join(' ')}></span>
- </button>
- </FormLayout>
- )
-}
-
-export default Toggle
diff --git a/packages/ui/src/components/Toggle/index.tsx b/packages/ui/src/components/Toggle/index.tsx
deleted file mode 100644
index fccc0c7e875..00000000000
--- a/packages/ui/src/components/Toggle/index.tsx
+++ /dev/null
@@ -1 +0,0 @@
-export { default as Toggle } from './Toggle'
diff --git a/packages/ui/src/lib/theme/defaultTheme.ts b/packages/ui/src/lib/theme/defaultTheme.ts
index 533e24814cb..ae2a8d06ad4 100644
--- a/packages/ui/src/lib/theme/defaultTheme.ts
+++ b/packages/ui/src/lib/theme/defaultTheme.ts
@@ -497,60 +497,6 @@ export default {
`,
},
- /*
- * Toggle
- */
-
- toggle: {
- base: `
- p-0 relative
- inline-flex shrink-0
- border-2 border-transparent
- rounded-full
- cursor-pointer
- transition-colors ease-in-out duration-200
- ${defaults.focus}
- focus:!ring-border
- bg-foreground-muted/40
-
- hover:bg-foreground-muted/60
- `,
- active: `
- !bg-brand
- !hover:bg-brand
- `,
- handle_container: {
- tiny: 'h-4 w-7',
- small: 'h-6 w-11',
- medium: 'h-6 w-11',
- large: 'h-7 w-12',
- xlarge: 'h-7 w-12',
- },
- handle: {
- base: `
- inline-block h-5 w-5
- rounded-full
- bg-white
- shadow ring-0
- transition
- ease-in-out duration-200
- `,
- tiny: '!h-3 !w-3',
- small: '!h-5 !w-5',
- medium: '!h-5 !w-5',
- large: '!h-6 !w-6',
- xlarge: '!h-6 !w-6',
- },
- handle_active: {
- tiny: ' translate-x-3 dark:bg-white',
- small: 'translate-x-5 dark:bg-white',
- medium: 'translate-x-5 dark:bg-white',
- large: 'translate-x-5 dark:bg-white',
- xlarge: 'translate-x-5 dark:bg-white',
- },
- disabled: 'opacity-75 cursor-not-allowed',
- },
-
/*
* Form Layout
*/