ControlField

ControlField combines a label, description, and a control (Switch, Checkbox, or Radio) into a single pressable row.

Source

View source code

LLM docs

LLM documentation

Package

@platform-blocks/react-ui-library

Examples

⁽⁴⁾

Properties

⁽³⁸⁾

Playground

Basics

A controlled switch row — the whole row is a single tap target.

Loading demo…

import
 
{
 useState 
}
 
from
 
'react'
;
import
 
{
 
ControlField
 
}
 
from
 
'@platform-blocks/react-ui-library'
;
 
export
 
function
 
Demo
(
)
 
{
  
const
 
[
enabled
,
 setEnabled
]
 
=
 
useState
(
true
)
;
 
  
return
 
(
    
<ControlField
      
label
=
"Push notifications"
      
description
=
"Get notified when something happens"
      
isSelected
=
{
enabled
}
      
onSelectedChange
=
{
setEnabled
}
    
/>
  
)
;
}

Checkbox with validation

A consent row using the checkbox variant. When left unchecked the field shows an error message below the row.

Loading demo…

import
 
{
 useState 
}
 
from
 
'react'
;
import
 
{
 
ControlField
 
}
 
from
 
'@platform-blocks/react-ui-library'
;
 
export
 
function
 
Demo
(
)
 
{
  
const
 
[
agreed
,
 setAgreed
]
 
=
 
useState
(
false
)
;
 
  
return
 
(
    
<ControlField
      
variant
=
"checkbox"
      
indicatorPosition
=
"left"
      
label
=
"I agree to the Terms of Service"
      
description
=
"You must accept before continuing"
      isRequired
      
isSelected
=
{
agreed
}
      
onSelectedChange
=
{
setAgreed
}
      
isInvalid
=
{
!
agreed
}
      
error
=
{
!
agreed 
?
 
'This field is required'
 
:
 
undefined
}
    
/>
  
)
;
}

Custom control

Compose the row explicitly with ControlField.Indicator to drop in a custom control — here a warning-colored checkbox.

Loading demo…

import
 
{
 useState 
}
 
from
 
'react'
;
import
 
{
 
Block
,
 
Checkbox
,
 
ControlField
 
}
 
from
 
'@platform-blocks/react-ui-library'
;
 
export
 
function
 
Demo
(
)
 
{
  
const
 
[
subscribed
,
 setSubscribed
]
 
=
 
useState
(
false
)
;
 
  
return
 
(
    
<ControlField
 
isSelected
=
{
subscribed
}
 
onSelectedChange
=
{
setSubscribed
}
>
      
<Block
 
style
=
{
{
 flex
:
 
1
 
}
}
 
fullWidth
=
{
false
}
>
        
<ControlField.Label
>
Subscribe
 to newsletter
</ControlField.Label
>
        
<ControlField.Description
>
          
One
 email a week
,
 unsubscribe anytime
        
</ControlField.Description
>
      
</Block
>
      
<ControlField.Indicator
>
        
<Checkbox
 
color
=
"warning"
 
/>
      
</ControlField.Indicator
>
    
</ControlField
>
  
)
;
}

Grouped surface

Wrap rows in ControlField.Group to get an iOS-style settings surface — a rounded, filled background with hairline dividers between rows. The group can carry an optional title and footer, and sets a shared size for its children.

Loading demo…

import
 
{
 useState 
}
 
from
 
'react'
;
import
 
{
 
ControlField
 
}
 
from
 
'@platform-blocks/react-ui-library'
;
 
export
 
function
 
Demo
(
)
 
{
  
const
 
[
wifi
,
 setWifi
]
 
=
 
useState
(
true
)
;
  
const
 
[
bluetooth
,
 setBluetooth
]
 
=
 
useState
(
false
)
;
  
const
 
[
airplane
,
 setAirplane
]
 
=
 
useState
(
false
)
;
 
  
return
 
(
    
<ControlField.Group
      
variant
=
"bordered"
      
title
=
"Connectivity"
      
footer
=
"Airplane mode disables all wireless radios."
    
>
      
<ControlField
 
label
=
"Wi-Fi"
 
isSelected
=
{
wifi
}
 
onSelectedChange
=
{
setWifi
}
 
/>
      
<ControlField
        
label
=
"Bluetooth"
        
isSelected
=
{
bluetooth
}
        
onSelectedChange
=
{
setBluetooth
}
      
/>
      
<ControlField
        
label
=
"Airplane mode"
        
description
=
"Turn off all connections"
        
isSelected
=
{
airplane
}
        
onSelectedChange
=
{
setAirplane
}
      
/>
    
</ControlField.Group
>
  
)
;
}

Scan to open this page on your phonereact-ui-library.com/components/ControlField

</>

react-ui-library

100+ accessible, themeable components that work seamlessly across iOS, Android, and Web.

A Platform Blocks product.

Quick Links

Components Charts Hooks

Docs

Getting Started Localization llms.txt

Resources

FAQ Changelog Accessibility Sitemap