PPolaris ComponentsConnect an agent

Knob

The compact square toggle Shopify uses in admin settings rows, built as a real switch button with a sliding knob and a focus ring.

Preview

Code

Example.jsx
import { useState } from 'react';
import { Badge, Card, InlineStack, Text } from '@shopify/polaris';

const KNOB_STYLES = `
  .Knob-Track {
    position: relative;
    display: flex;
    align-items: center;
    height: 1.25rem;
    width: 2rem;
    padding: 0.25rem;
    background: var(--p-color-icon-secondary);
    box-shadow: inset 0 0.0625rem 0.25rem rgba(0, 0, 0, 0.05);
    border: none;
    border-radius: 0.375rem;
    cursor: pointer;
    transition: background var(--p-motion-duration-50) var(--p-motion-ease);
  }
  .Knob-Track::after {
    content: '';
    position: absolute;
    z-index: 1;
    top: -0.0625rem;
    right: -0.0625rem;
    bottom: -0.0625rem;
    left: -0.0625rem;
    display: block;
    pointer-events: none;
    box-shadow: 0 0 0 -0.0625rem var(--p-color-border-focus);
    transition: box-shadow var(--p-motion-duration-100) var(--p-motion-ease);
    border-radius: calc(var(--p-border-radius-100) + 0.0625rem);
  }
  .Knob-Track:focus-visible {
    outline: none;
  }
  .Knob-Track:focus-visible::after {
    box-shadow: 0 0 0 0.125rem var(--p-color-border-focus);
  }
  .Knob-Track:hover {
    background: rgba(97, 97, 97, 1);
  }
  .Knob-Track--on {
    background: var(--p-color-bg-inverse);
  }
  .Knob-Track--on:hover {
    background: rgba(48, 48, 48, 1);
  }
  .Knob-Handle {
    height: 0.75rem;
    width: 0.75rem;
    border-radius: 0.1875rem;
    background: var(--p-color-bg-surface);
    transition: transform var(--p-motion-duration-50) var(--p-motion-ease);
  }
  .Knob-Handle--on {
    transform: translateX(100%);
  }
`;

export const Example = () => {
  const [selected, setSelected] = useState(false);

  return (
    <Card>
      <style>{KNOB_STYLES}</style>
      <InlineStack align="space-between" blockAlign="center">
        <InlineStack align="start" gap="200" blockAlign="center">
          <Text as="p" variant="bodyMd">
            Toggle Knob
          </Text>
          <Badge tone={selected ? 'success' : 'attention'}>
            {selected ? 'Enabled' : 'Disabled'}
          </Badge>
        </InlineStack>
        <button
          type="button"
          role="switch"
          aria-checked={selected}
          aria-label="Example knob"
          className={selected ? 'Knob-Track Knob-Track--on' : 'Knob-Track'}
          onClick={() => setSelected((prev) => !prev)}
        >
          <span className={selected ? 'Knob-Handle Knob-Handle--on' : 'Knob-Handle'} />
        </button>
      </InlineStack>
    </Card>
  );
};