@regulaforensics/ui-components 7.6.291-nightly → 7.6.294-nightly

package/dist/index.d.ts

@@ -7,36 +7,49 @@ import { ReactNode } from 'react';
 import { RefAttributes } from 'react';
 import { TDetectResponse } from '@regulaforensics/facesdk-webclient';
 
+/** Displays the document processing time and additional fields. */
 export declare const About: FC<IAboutProps>;
 
+/** Arrow icon */
 declare const Arrow: FC<IArrowProps>;
 
 declare const AuthenticityLabel: FC<iAuthenticityLabelProps>;
 
 declare const AuthenticityTextCheckReference: FC<iAuthenticityTextCheckReferenceProps>;
 
+/** Skeleton. */
 declare const Block: FC<IBlockProps>;
 
+/** Brackets icon. */
 declare const Brackets: FC<IBracketsProps>;
 
 declare const CheckDiagnose: FC<iCheckDiagnoseProps>;
 
 declare const CheckResultVerification: FC<iCheckResultVerificationProps>;
 
+/** ClosedEye icon. */
 declare const ClosedEye: FC<IClosedEyeProps>;
 
+/** A content area which can be collapsed and expanded. */
 export declare const Collapse: FC<ICollapseProps>;
 
 export declare const Container: IContainer;
 
+/** Copy icon. */
 declare const Copy: FC<ICopyProps>;
 
+/** Cross icon. */
 declare const Cross: FC<ICrossProps>;
 
+/** Icon for missing images. */
 export declare const DefaultImage: FC<IDefaultImageProps>;
 
+/** Context provider component. Provides all child components with response, request, and selected language.
+ * The components used to display the results of document processing must be wrapped with it.
+ */
 export declare const DocReaderContainer: FC<IDocReaderContainerProps>;
 
+/** Download icon. */
 declare const Download: FC<IDownloadProps>;
 
 export declare enum eInfoTabID {
@@ -46,12 +59,17 @@ export declare enum eInfoTabID {
     IDENTIFICATION = "IDENTIFICATION"
 }
 
+/** Eye icon. */
 declare const Eye: FC<IEyeProps>;
 
+/** Context provider component. Provides all child components with face image quality data and selected language.
+ * The components used to display the results of face image quality must be wrapped with it.
+ */
 export declare const FaceContainer: FC<IFaceContainerProps>;
 
 declare const FaceImageQualityCheckLabel: FC<iFaceImageQualityCheckLabelProps>;
 
+/** Face image quality data. */
 export declare const FaceImageQualityData: () => JSX_2.Element | null;
 
 declare const FaceImageQualityLabel: FC<iFaceImageQualityLabelProps>;
@@ -104,11 +122,13 @@ declare const getVisualFieldType: (input: any) => string | number;
 
 declare const GraphicFieldType: FC<iGraphicFieldTypeProps>;
 
+/** The images contained in the response. */
 export declare const Graphics: () => JSX_2.Element | null;
 
 declare const GroupDescription: FC<iGroupDescriptionProps>;
 
 declare interface IAboutProps {
+    /** Additional fields. */
     additionalFields?: Array<{
         name: string;
         value: string | number;
@@ -116,8 +136,10 @@ declare interface IAboutProps {
 }
 
 declare interface IArrowProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface iAuthenticityLabelProps {
@@ -129,14 +151,19 @@ declare interface iAuthenticityTextCheckReferenceProps {
 }
 
 declare interface IBlockProps extends HTMLAttributes<HTMLDivElement> {
+    /** Skeleton width. */
     width?: number | string;
+    /** Skeleton height. */
     height?: number | string;
+    /** Skeleton border radius. */
     borderRadius?: number;
 }
 
 declare interface IBracketsProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface iCheckDiagnoseProps {
@@ -148,16 +175,24 @@ declare interface iCheckResultVerificationProps {
 }
 
 declare interface IClosedEyeProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 export declare interface ICollapseProps extends HTMLAttributes<HTMLDivElement> {
+    /** Title of the content. */
     head: ReactNode;
+    /** The ability to collapse and expand content. */
     collapse?: boolean;
+    /** The initial state of the hidden content, expanded or collapsed. */
     open?: boolean;
+    /** Collapsed content. */
     children: ReactNode;
+    /** Component style type. */
     type?: 'nested' | 'rounded';
+    /** The callback function that is triggered when the content is collapsed or expanded. */
     onOpen?: (isOpen: boolean) => void;
 }
 
@@ -170,37 +205,51 @@ declare interface IContainer extends FC {
 }
 
 declare interface ICopyProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface ICrossProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IDefaultImageProps extends HTMLAttributes<HTMLDivElement> {
+    /** Icon type. */
     type?: ImageType;
 }
 
 declare interface IDocReaderContainerProps extends HTMLAttributes<HTMLElement> {
+    /** Processing response object. */
     response: unknown;
+    /** Request object. */
     request?: any;
+    /** Selected language. */
     language?: string;
 }
 
 declare interface IDownloadProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IEyeProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IFaceContainerProps extends HTMLAttributes<HTMLElement> {
+    /** Image quality data. */
     quality: TDetectResponse;
+    /** Selected language. */
     language?: string;
 }
 
@@ -248,18 +297,31 @@ declare interface IIcon extends FC {
 }
 
 declare interface IImageProps extends HTMLAttributes<HTMLDivElement> {
+    /** Path to the image. */
     src: string;
+    /** Specifies an alternate text for an image, if the image cannot be displayed. */
     alt: string;
+    /** Indicates whether the element can be dragged. */
     draggable?: boolean;
+    /** Displaying a button for downloading an image. */
     download?: boolean;
+    /** Magnifier display. */
     magnifier?: boolean;
+    /** Full-screen image display. */
     viewer?: boolean;
+    /** Zoom level of the magnifier. */
     zoomLevel?: number;
+    /** Magnifier width. */
     magnifierWidth?: number;
+    /** Magnifier height.  */
     magnifierHeight?: number;
+    /** Path to the magnifier image. Default magnifierImg === src */
     magnifierImg?: string;
+    /** Path to the preview image. Default previewImg === src */
     previewImg?: string;
+    /** Path to the image to download. Default downloadImg === src */
     downloadImg?: string;
+    /** Magnifier image border radius. */
     magnifierImgBorderRadius?: number;
 }
 
@@ -267,11 +329,17 @@ declare interface iImageQualityCheckTypeLabelProps {
     children: ReactNode;
 }
 
+declare interface IInfoProps {
+    /** Additional content above the results */
+    additionalResultsContent?: ReactNode;
+}
+
 declare interface iIRVisibilityStatusProps {
     children: ReactNode;
 }
 
 declare interface IJsonViewerProps {
+    /** Input data. */
     data: any;
 }
 
@@ -284,15 +352,22 @@ declare interface iLightsLabelProps {
 }
 
 declare interface ILinkArrowProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface ILinkProps extends HTMLAttributes<HTMLDivElement> {
+    /** Link address. */
     href: string;
+    /** specifies where to open the linked document. */
     target?: string;
+    /** Link label. */
+    children: ReactNode;
 }
 
+/** An image wrapper that adds various utilities. */
 declare const Image_2: ForwardRefExoticComponent<IImageProps & RefAttributes<HTMLDivElement>>;
 export { Image_2 as Image }
 
@@ -301,8 +376,10 @@ declare const ImageQualityCheckTypeLabel: FC<iImageQualityCheckTypeLabelProps>;
 declare type ImageType = 'photo' | 'passport' | 'id-card';
 
 declare interface IMagnifierProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IMatch extends FC {
@@ -355,15 +432,20 @@ declare interface IMatch extends FC {
 }
 
 declare interface IMenuProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
-export declare const Info: () => JSX_2.Element | null;
+/** Document images and document processing results. */
+export declare const Info: FC<IInfoProps>;
 
 declare interface INotVerifiedProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface iOpticalStatusFieldProps {
@@ -371,12 +453,17 @@ declare interface iOpticalStatusFieldProps {
 }
 
 declare interface IPersonInfoProps {
+    /** Portrait display. */
     showPortrait?: boolean;
+    /** Component class name. */
     className?: string;
 }
 
 export declare interface IPopoverProps extends HTMLAttributes<HTMLDivElement> {
+    /** Hint content. */
     modal: ReactNode;
+    /** Text label. */
+    children: ReactNode;
 }
 
 declare interface iPortraitComparisonSourceProps {
@@ -384,16 +471,21 @@ declare interface iPortraitComparisonSourceProps {
 }
 
 declare interface IQuestionProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IRefreshProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IRequestViewerProps {
+    /** Section title. */
     title?: string;
 }
 
@@ -416,7 +508,10 @@ declare interface iRfidDataFileTypeProps {
 declare const IRVisibilityStatus: FC<iIRVisibilityStatusProps>;
 
 declare interface IScrollProps extends HTMLAttributes<HTMLDivElement> {
+    /** The maximum height of the content after which the scroll appears. */
     maxHeight?: number;
+    /** Content. */
+    children: ReactNode;
 }
 
 declare interface iSecurityFeatureTypeLabelProps {
@@ -440,6 +535,7 @@ declare interface iSourceProps {
 }
 
 declare interface IStatusProps {
+    /** Additional fields. */
     additionalFields?: Array<{
         name: string;
         value: string | number;
@@ -447,7 +543,9 @@ declare interface IStatusProps {
 }
 
 export declare interface ITableProps extends HTMLAttributes<HTMLTableElement> {
+    /** Rows content. */
     dataSource: Array<Record<string, ReactNode>>;
+    /** Columns. */
     columns: Array<{
         title: string;
         dataIndex: string;
@@ -455,13 +553,17 @@ export declare interface ITableProps extends HTMLAttributes<HTMLTableElement> {
 }
 
 export declare interface ITabsProps extends HTMLAttributes<HTMLDivElement> {
+    /** Tabs content. */
     items: Array<{
         id: string | number;
         label: string;
         children: ReactNode;
     }>;
+    /** The ID of the initial tab. */
     initialTab?: string | number;
+    /** Component style type. */
     type?: 'line' | 'card';
+    /** the callback function that is triggered when switching tabs. */
     onTabChange?: (tabIndex: number | string) => void;
 }
 
@@ -473,17 +575,22 @@ export declare interface ITextProps extends HTMLAttributes<HTMLSpanElement> {
 }
 
 declare interface IUnknownProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
-declare interface IVerificationsProps {
-    type?: 'collapse';
+declare interface IVerificationsProps extends HTMLAttributes<HTMLDivElement> {
+    /** Component style type. */
+    type?: 'list' | 'collapse';
 }
 
 declare interface IVerifiedProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface iVisualFieldTypeProps {
@@ -491,55 +598,75 @@ declare interface iVisualFieldTypeProps {
 }
 
 declare interface IWarningProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
 declare interface IZipProps extends HTMLAttributes<HTMLSpanElement> {
-    size?: number;
+    /** Icon fill color. */
     fillColor?: string;
+    /** Icon size. */
+    size?: number;
 }
 
+/** A component for displaying any objects. */
 export declare const JsonViewer: FC<IJsonViewerProps>;
 
 declare const LCID: FC<iLcidProps>;
 
 declare const LightsLabel: FC<iLightsLabelProps>;
 
+/** The link component. */
 export declare const Link: FC<ILinkProps>;
 
+/** LinkArrow icon. */
 declare const LinkArrow: FC<ILinkArrowProps>;
 
+/** Logs of document processing. */
 export declare const Logs: () => JSX_2.Element | null;
 
+/** Magnifier icon. */
 declare const Magnifier: FC<IMagnifierProps>;
 
 export declare const Match: IMatch;
 
+/** Menu icon. */
 declare const Menu: FC<IMenuProps>;
 
+/** NotVerified icon. */
 declare const NotVerified: FC<INotVerifiedProps>;
 
 declare const OpticalStatusField: FC<iOpticalStatusFieldProps>;
 
+/** Document processing status. */
 export declare const Overall: () => JSX_2.Element | null;
 
+/** Personal data. */
 export declare const PersonInfo: FC<IPersonInfoProps>;
 
+/** Text with a hint. */
 export declare const Popover: FC<IPopoverProps>;
 
 declare const PortraitComparisonSource: FC<iPortraitComparisonSourceProps>;
 
+/** Portraits comparison. */
 export declare const PortraitsComparison: () => JSX_2.Element | null;
 
+/** Question icon. */
 declare const Question: ForwardRefExoticComponent<IQuestionProps & RefAttributes<HTMLSpanElement>>;
 
+/** Refresh icon. */
 declare const Refresh: FC<IRefreshProps>;
 
+/** Processing request object. */
 export declare const RequestViewer: FC<IRequestViewerProps>;
 
+/** Processing response object. */
 export declare const ResponseViewer: () => JSX_2.Element | null;
 
+/** RFID data. */
 export declare const Rfid: () => JSX_2.Element | null;
 
 declare const RfidApplicationDescription: FC<iRfidApplicationDescriptionProps>;
@@ -550,6 +677,7 @@ declare const RfidCertificateType: FC<iRfidCertificateTypeProps>;
 
 declare const RfidDataFileType: FC<iRfidDataFileTypeProps>;
 
+/** Custom scroll. */
 export declare const Scroll: FC<IScrollProps>;
 
 declare const SecurityFeatureTypeLabel: FC<iSecurityFeatureTypeLabelProps>;
@@ -564,12 +692,16 @@ declare const Source: FC<iSourceProps>;
 
 declare const SourceDescription: FC<iSourceDescriptionProps>;
 
+/** Includes Overall, Verifications, PersonInfo and About components. */
 export declare const Status: FC<IStatusProps>;
 
+/** Status skeleton. */
 export declare const StatusLoader: () => JSX_2.Element;
 
+/** Tables display sets of data. */
 export declare const Table: FC<ITableProps>;
 
+/** The Tab component allows users to switch between multiple content panels. */
 export declare const Tabs: FC<ITabsProps>;
 
 declare const Text_2: FC<ITextProps>;
@@ -577,16 +709,21 @@ export { Text_2 as Text }
 
 export declare const Title: FC<IH1Props>;
 
+/** Unknown icon. */
 declare const Unknown: FC<IUnknownProps>;
 
+/** List of verifications. */
 export declare const Verifications: FC<IVerificationsProps>;
 
+/** Verified icon. */
 declare const Verified: FC<IVerifiedProps>;
 
 declare const VisualFieldType: FC<iVisualFieldTypeProps>;
 
+/** Warning icon. */
 declare const Warning: FC<IWarningProps>;
 
+/** Zip icon. */
 declare const Zip: FC<IZipProps>;
 
 export { }