react-lgpd-consent v0.9.1
    Preparing search index...

    Interface PreferencesModalProps

    Propriedades para customizar o comportamento e aparência do componente PreferencesModal.

    Esta interface permite controle total sobre o modal de preferências de consentimento LGPD. O modal pode ser usado de duas formas:

    • Automático: Renderizado pelo ConsentProvider quando usuário clica em "Preferências"
    • Manual: Controlado externamente via props isModalOpen, preferences, etc.
    • Suporte completo a theming via ThemeProvider
    • Props diretas para Dialog do MUI via DialogProps
    • Compatibilidade com design tokens customizados

    Components

    0.1.0

    <ConsentProvider
      categories={{ enabledCategories: ['analytics'] }}
      preferencesModalProps={{ hideBranding: true }}
    >
      <App />
    </ConsentProvider>

    function CustomPreferencesModal() {
      const [open, setOpen] = useState(false)
      const { preferences, setPreferences } = useConsent()

      return (
        <PreferencesModal
          isModalOpen={open}
          preferences={preferences}
          setPreferences={setPreferences}
          closePreferences={() => setOpen(false)}
          DialogProps={{ maxWidth: 'md' }}
        />
      )
    }
    interface PreferencesModalProps {
        closePreferences?: () => void;
        DialogProps?: Partial<DialogProps>;
        hideBranding?: boolean;
        isModalOpen?: boolean;
        language?: "fr" | "pt" | "en" | "es" | "de" | "it";
        preferences?: ConsentPreferences;
        setPreferences?: (preferences: ConsentPreferences) => void;
        texts?: Partial<AdvancedConsentTexts>;
        textVariant?: "formal" | "casual" | "concise" | "detailed";
    }
    Index

    Properties

    closePreferences? DialogProps? hideBranding? isModalOpen? language? preferences? setPreferences? texts? textVariant?

    Properties

    closePreferences?: () => void

    Função para fechar o modal passada pelo Provider.

    Callback invocado quando usuário cancela ou após salvar preferências. Se omitido, usa a função do contexto.

    undefined (usa função do contexto)
    DialogProps?: Partial<DialogProps>

    Propriedades opcionais para customizar o componente Dialog do Material-UI.

    Permite customização avançada do comportamento do modal: posição, transição, largura máxima, e outros atributos do Dialog do MUI.

    undefined

    <PreferencesModal
      DialogProps={{
        maxWidth: 'md',
        fullWidth: true,
        TransitionComponent: Slide
      }}
    />
    hideBranding?: boolean

    Se true, oculta a marca "fornecido por LÉdipO.eti.br" no modal.

    A biblioteca é open-source e gratuita. O branding é uma forma de apoiar o projeto, mas pode ser removido se necessário para sua marca.

    false
    isModalOpen?: boolean

    Estado de abertura do modal passado pelo Provider.

    Quando fornecido via PreferencesModalComponent no ConsentProvider, substitui o valor do hook useConsent. Permite controle externo do estado.

    undefined (usa valor do contexto)
    language?: "fr" | "pt" | "en" | "es" | "de" | "it"

    Idioma local para resolver texts.i18n.

    preferences?: ConsentPreferences

    Preferências de consentimento passadas pelo Provider.

    Quando fornecido via PreferencesModalComponent, permite sincronização externa do estado de preferências. Se omitido, usa o contexto interno.

    undefined (usa valor do contexto)
    setPreferences?: (preferences: ConsentPreferences) => void

    Função para atualizar preferências passada pelo Provider.

    Type Declaration

    Permite override da função de atualização de preferências. Útil para integração com gerenciadores de estado externos.

    undefined (usa função do contexto)
    texts?: Partial<AdvancedConsentTexts>

    Textos customizados para o modal. Permite sobrescrever textos do contexto e aplicar i18n localmente.

    textVariant?: "formal" | "casual" | "concise" | "detailed"

    Variação de tom local para resolver texts.variants.

    Settings

    Member Visibility

    On This Page

    Integração com Material-UI
    Properties