Checkbox Card

5.2.7

Checkboxes can be used to turn an option on or off.

Demo

NamnTypBeskrivning

active *

booleanIndicates if the card is currently active.

activeState

"active" | "warning"Defines the border color of the card when it is active.

boxProps

PartialDue to a problem when using RadioButtonCard together with toggle button, the box has to

cardSize

"small" | "medium"Specifies a fixed size for the card, overriding responsive breakpoints.

cardSx

SxPropsThe system prop that allows defining system overrides as well as additional CSS styles.

children

ReactNode

customAttribute

{ attribute: string; value: string | number }Used for tests. Clickable and requested subcomponents will be suffixed with "-[ComponentName]".

disableContentPadding

booleanProp to disable padding on the bottom content. Use this if you need to use the full width

disableRightComponentPadding

booleanIf true, disables padding in the right component.

elevation

numberThe elevation of the card.

error

booleanIndicates if the component is in an error state, applying error-specific styling for validation feedback.

id *

stringA unique ID for the checkbox input.

limitedClickArea

booleanIf the card should limit the interactive area to the top portion. Needed for accessibility if lower portion contains another interactive element

onChange

(event: ChangeEvent) => voidChange event handler

onSizeChange

(size: undefined | "small" | "medium") => voidCallback for when the card size changes. Used in CheckboxPriceCard

value *

stringValue fo the checkbox

wrapRightComponentToBottom

booleanIf the card should wrap the right component to the bottom on very small breakpoints. Used in RadioPriceCard.

Installation

npm install @sj-ab/component-library.ui.checkbox-card

Länkar

Tillgänglighet

Semantik

CheckboxCard presenteras som en HTML kryssruta. <input> är dolt visuellt och syns enbart för skärmläsare.

<input type="checkbox" aria-labelledby="checkbox-button-card-label-container">

Tillgängligt namn

CheckboxCard får automatiskt ett tillgängligt namn för skärmläsare från den synliga texten som sätts med label, labelSecondaryText, labelPrimaryMeta, labelSecondaryMeta, samt eventuellt innehåll i rightComponent.

Allt innehåll inuti kortets children kopplas till <input> med aria-describedby så att även de läses upp av skärmläsare när kryssrutan får fokus.

Allt detta sköts internt inne i komponenten med aria-labelledby och aria-describedby

Begränsad klickyta

Som standard är hela kortet klickbart och del av samma klickyta.

Om du vill placera ett annat klickbart objekt inuti CheckboxCard, till exempel en länk, måste du använda propen limitClickArea. Detta är mycket viktigt för att undvika tillgänglighetsproblem med nästlade interaktiva objekt!

Då kommer enbart den övre delen i kortet vara klickbart. Alla children blir egna fristående element i DOM:en.

Checkbox card med begränsad klickyta

Checkbox Card med begränsad klickyta

200% textförstoring

Checkbox Card har inbyggt stöd för textförstoring upp till 200% på alla skärmstorlekar. När det blir ont om plats kommer meta-texterna till höger flyttas ner och läggas under.

Change log

Statistik

  • Importer av Checkbox Card

    15
  • Repos med Checkbox Card

    40%
  • Senaste installerade version av Checkbox Card

    5.2.3
  • Äldsta installerade version av Checkbox Card

    5.2.3