Skip to contentPorsche Design System
You are currently viewing an earlier release of the Porsche Design System.Switch to the latest Porsche Design System documentation.
SearchGitHub repository of Porsche Design SystemOpen settings sidebar
Checkbox Table of Contents Accessibility support Keyboard Key / stateFunctionTab, Shift-TabMoves focus to the next (or previous) focusable element.SpaceActivates/Deactivates checkbox. ARIA enhancements External ARIA provided by the aria property: Use the aria property to pass supported attributes to the native control inside the shadow DOM. Prefer a visible label for the accessible name. Use aria-label when the label is hidden or insufficient, and aria-description for extra context that should not replace the name. ARIAUsagearia-labelDefines an accessible name when the visible label is insufficient or hidden; prefer a visible label for most cases.aria-descriptionProvides additional context for assistive technologies without replacing the accessible name. Internal ARIA that is managed by the component: ARIAUsagearia-describedby="IDREF"References the accessible description of status messages.role="status", role="alert"When message and state or loading prop change, the status message is announced.aria-hidden="true"If required attribute is set, the visible asterisk indicator is hidden from assistive technologies.aria-invalid="true"If error state is set. Development considerations Disabled state In general, avoid using the disabled state. Disabled elements are no longer focusable and may be missed by screen reader users. They can also confuse sighted users if the reason they are disabled is not made clear. Common do's and don'ts Do pass extra labelling through the aria prop (aria-label, aria-description). Do provide a clear label that describes what the checkbox controls. Do use the component state/message API so validation and status changes are announced. Do use clear error wording that helps users recover. Don't use hide-label without an accessible name. Don't add native aria-* attributes directly on the component host. Don't use hide-label when it is not clear what the checkbox controls. Integration examples
ARIA on component host vs aria prop❌ Anti-pattern
<p-checkbox name="terms" label="I accept the terms" aria-label="Accessible name" aria-description="Additional context"></p-checkbox>
✅ Recommended
<p-checkbox name="terms" label="I accept the terms" aria="{'aria-label': 'Accessible name', 'aria-description': 'Additional context'}"></p-checkbox>
Hidden label without accessible name❌ Anti-pattern
<p-checkbox name="terms" hide-label="true"></p-checkbox>
✅ Recommended
<p-checkbox name="terms" hide-label="true" label="I accept the terms and conditions"></p-checkbox>
Validation feedback via state and message API❌ Anti-pattern
<p-checkbox name="terms" label="I accept the terms and conditions" aria-invalid="true" message="Required"></p-checkbox>
✅ Recommended
<p-checkbox name="terms" label="I accept the terms and conditions" required="true" state="error" message="Accept the terms and conditions to continue."></p-checkbox>
Tests Automated TechnologySupportAXE-Core (WCAG 2.2 AA, Best-Practice)✅High-Contrast Mode (light/dark)✅Text-Zoom (200%)✅ Manual TechnologySupportKeyboard✅Screen reader (VoiceOver, NVDA)✅
v4.8.0v2v1
Global settingsColor SchemeAll color tokens use the light-dark() CSS function. Set the theme via the CSS color-scheme property: light for light mode, dark for dark mode, or light dark to follow the user's system preference.LightDarkLight DarkDirectionThe dir global attribute in HTML changes the direction of text and other content within an element. It's most often used on the <html> tag to set the entire page's direction, which is crucial for supporting languages that are written from right to left (RTL), such as Arabic and Hebrew. For example, using <html dir="rtl"> makes the entire page display from right to left, adjusting the layout and text flow accordingly.LTR (left-to-right)RTL (right-to-left)Text ZoomTo ensure accessibility and comply with WCAG 2.2 AA standards, it is mandatory for web content to support text resizing up to at least 200% without loss of content or functionality. Using relative units like rem is a best practice for achieving this, as they allow the text to scale uniformly based on the user's browser settings.100%130%150%200%