SignIn.Header.Description

Description component for the sign-in header section

  • Stable unknown
  • Release candidate since 1.16.1-rc.3
  • Development since 1.16.1-dev.2111+9796905

Description component for the sign-in header section that provides contextual information with localization support.

Quick Example

import { SignIn } from "@ovok/native";
import React from "react";

const DescriptionExample = () => {
  return (
    <SignIn.Header>
      <SignIn.Header.Description>
        Enter your credentials to continue
      </SignIn.Header.Description>
    </SignIn.Header>
  );
};

export default DescriptionExample;

Props

Every prop, with its type and description, is listed in the @ovok/native/auth API reference.

Localization

The component uses the following translation keys:

{
  "sign-in": {
    "subtitle": "Log in to your account to start using Actimi products."
  }
}

Default Behavior

When no children prop is provided, the component automatically displays the localized subtitle:

<SignIn.Header.Description />

This renders the value of t("sign-in.subtitle") which defaults to "Log in to your account to start using Actimi products."

Last updated on

On this page