ConsentBlock

Kurulum

Paket

@bigbang/ui

İçe aktarma

import { ConsentBlock } from '@bigbang/ui';

Kaynak

ConsentBlock.tsx

Storybook

ConsentBlock · Playground

ConsentBlock, @bigbang/ui paketindedir.

import { ConsentBlock } from '@bigbang/ui';

<ConsentBlock title="Kullanım koşulları" checkboxLabel="Koşulları okudum ve kabul ediyorum." requireScroll required name="terms">
  <p>…</p>
</ConsentBlock>;

Özellikler

itemsZorunlu

Açıklama

Her amaç için bir öğe. KVKK kapsamındaki açık rıza bir sözleşmeyi kabul etmeye ya da pazarlamaya hiçbir zaman bağlanmaz.

Tür

readonly ConsentItem[]

valueZorunlu

Açıklama

Kabul edilen öğelerin id'leri. onValueChange ile birlikte kullanın.

Tür

readonly string[]

onValueChangeZorunlu

Açıklama

Bir öğe işaretlenince ya da işareti kaldırılınca kabul edilen öğelerin id'leriyle çağrılır.

Tür

(ids: readonly string[]) => void

onOpenDocumentZorunlu

Açıklama

Belgeyi sayfada bir iletişim kutusunda açar, asla yeni sekmede değil; kişi sonuna ulaşınca okundu sayın (readIds'e ekleyin).

Tür

(documentId: string) => void

readIds

Açıklama

Belgesi okunmuş öğelerin id'leri; mustRead öğelerin kilidini açar.

Tür

readonly string[]

error

Açıklama

Onay kutusunun altındaki hata, örneğin form onaysız gönderildiğinde.

Tür

string

name

Açıklama

Onay kutusunun alan adı.

Tür

string

className

Açıklama

Kök öğeye eklenir; yalnızca yerleşim için kullanın.

Tür

string

titleZorunlu

Açıklama

Metnin adı; başlık olarak gösterilir ve kaydırma alanını adlandırır: 'Kullanım koşulları'.

Tür

string

childrenZorunlu

Açıklama

Okunacak metin: paragraflar ve listeler.

Tür

ReactNode

checkboxLabelZorunlu

Açıklama

Onay kutusunun metni, kişinin cümlesi olarak: 'Koşulları okudum ve kabul ediyorum.'

Tür

ReactNode

headingLevel

Açıklama

Başlığın düzeyi.

Tür

2 | 3 | 4

Varsayılan

3

meta

Açıklama

Başlığın yanında bir sürüm ya da tarih satırı.

Tür

ReactNode

href

Açıklama

Tam metnin bağlantısı; yeni sekmede açılır.

Tür

string

requireScroll

Açıklama

Onay kutusu metin sonuna kadar kaydırılana dek kilitli kalır; alana sığan kısa metin hemen okunmuş sayılır.

Tür

boolean

Varsayılan

false

checked

Açıklama

Denetimli işaret durumu. onCheckedChange ile birlikte kullanın.

Tür

boolean

defaultChecked

Açıklama

Denetimsiz kullanımda ilk işaret durumu.

Tür

boolean

Varsayılan

false

onCheckedChange

Açıklama

Yeni işaret durumuyla çağrılır.

Tür

(checked: boolean) => void

required

Açıklama

Form gönderilmeden önce onay kutusu işaretlenmelidir.

Tür

boolean

Varsayılan

false

Veri öznitelikleri

• data-component="consent-block" ve okununca data-read.
• data-part: body, progress, meta, error, announcement.