@razorpay/blade 9.5.1 → 9.5.3

package/build/components/index.native.d.ts

@@ -3096,6 +3096,72 @@ declare type CardBodyProps = {
 } & TestID;
 declare const CardBody: ({ children, testID }: CardBodyProps) => React__default.ReactElement;
 
+type FeedbackColors$1 = `feedback.text.${DotNotationColorStringToken<
+  Theme$1['colors']['feedback']['text']
+>}`;
+type FeedbackActionColors$1 = `feedback.${Feedback}.action.text.${DotNotationColorStringToken<
+  Theme$1['colors']['feedback'][Feedback]['action']['text']
+>}`;
+type SurfaceColors$1 = `surface.text.${DotNotationColorStringToken<
+  Theme$1['colors']['surface']['text']
+>}`;
+type ActionColors$1 = `action.text.${DotNotationColorStringToken<Theme$1['colors']['action']['text']>}`;
+type BadgeTextColors$1 = `badge.text.${DotNotationColorStringToken<
+  Theme$1['colors']['badge']['text']
+>}`;
+
+type BrandPrimaryColors$1 = `brand.primary.${keyof Theme$1['colors']['brand']['primary']}`;
+
+type As$1 =
+  | 'code'
+  | 'h1'
+  | 'h2'
+  | 'h3'
+  | 'h4'
+  | 'h5'
+  | 'h6'
+  | 'p'
+  | 'span'
+  | 'abbr'
+  | 'q'
+  | 'cite'
+  | 'figcaption'
+  | 'div';
+type BaseTextProps$1 = {
+  id?: string;
+  color?:
+    | BrandPrimaryColors$1
+    | ActionColors$1
+    | FeedbackColors$1
+    | SurfaceColors$1
+    | FeedbackActionColors$1
+    | BadgeTextColors$1;
+  fontFamily?: keyof Theme$1['typography']['fonts']['family'];
+  fontSize?: keyof Theme$1['typography']['fonts']['size'];
+  fontWeight?: keyof Theme$1['typography']['fonts']['weight'];
+  fontStyle?: 'italic' | 'normal';
+  textDecorationLine?: 'line-through' | 'none' | 'underline';
+  lineHeight?: keyof Theme$1['typography']['lineHeights'];
+  /**
+   * Web only
+   */
+  as?: As$1;
+  textAlign?: 'center' | 'justify' | 'left' | 'right';
+  truncateAfterLines?: number;
+  className?: string;
+  style?: React.CSSProperties;
+  children: React.ReactNode;
+  accessibilityProps?: Partial<AccessibilityProps>;
+  /**
+   * React Native only
+   */
+  numberOfLines?: number;
+  componentName?: 'base-text' | 'text' | 'title' | 'heading' | 'code';
+} & TestID &
+  StyledPropsBlade$1;
+
+type BaseTextSizes$1 = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
+
 declare type BaseLinkCommonProps = {
     intent?: 'positive' | 'negative' | 'notice' | 'information' | 'neutral';
     contrast?: 'low' | 'high';
@@ -3114,13 +3180,13 @@ declare type BaseLinkCommonProps = {
         native: (event: GestureResponderEvent) => void;
         web: (event: React__default.KeyboardEvent<HTMLButtonElement>) => void;
     }>;
-    accessibilityLabel?: string;
+    accessibilityProps?: Partial<AccessibilityProps>;
     /**
      * Sets the size of the link
      *
      * @default medium
      */
-    size?: 'xsmall' | 'small' | 'medium' | 'large';
+    size?: Extract<BaseTextSizes$1, 'xsmall' | 'small' | 'medium' | 'large'>;
     /**
      * Defines how far your touch can start away from the link. This is a react-native only prop and has no effect on web.
      */
@@ -3169,6 +3235,12 @@ declare type LinkCommonProps = {
     href?: string;
     target?: string;
     accessibilityLabel?: string;
+    /**
+     * It is exposed for internal usage with tooltip.
+     *
+     * @private
+     */
+    'aria-describedby'?: string;
     /**
      * Sets the size of the link
      *
@@ -3246,7 +3318,7 @@ declare type BaseButtonCommonProps = {
     }>;
     type?: 'button' | 'reset' | 'submit';
     isLoading?: boolean;
-    accessibilityLabel?: string;
+    accessibilityProps?: Partial<AccessibilityProps>;
     variant?: 'primary' | 'secondary' | 'tertiary';
     contrast?: 'low' | 'high';
     intent?: 'positive' | 'negative' | 'notice' | 'information' | 'neutral';
@@ -3286,6 +3358,12 @@ declare type ButtonCommonProps = {
     isLoading?: boolean;
     accessibilityLabel?: string;
     type?: 'button' | 'reset' | 'submit';
+    /**
+     * It is exposed for internal usage with tooltip.
+     *
+     * @private
+     */
+    'aria-describedby'?: string;
     onClick?: Platform.Select<{
         native: (event: GestureResponderEvent) => void;
         web: (event: React__default.MouseEvent<HTMLButtonElement>) => void;
@@ -3340,70 +3418,6 @@ declare type CounterProps = {
 } & TestID & StyledPropsBlade$1;
 declare const Counter: ({ value, max, intent, variant, contrast, size, testID, ...styledProps }: CounterProps) => React.ReactElement;
 
-type FeedbackColors$1 = `feedback.text.${DotNotationColorStringToken<
-  Theme$1['colors']['feedback']['text']
->}`;
-type FeedbackActionColors$1 = `feedback.${Feedback}.action.text.${DotNotationColorStringToken<
-  Theme$1['colors']['feedback'][Feedback]['action']['text']
->}`;
-type SurfaceColors$1 = `surface.text.${DotNotationColorStringToken<
-  Theme$1['colors']['surface']['text']
->}`;
-type ActionColors$1 = `action.text.${DotNotationColorStringToken<Theme$1['colors']['action']['text']>}`;
-type BadgeTextColors$1 = `badge.text.${DotNotationColorStringToken<
-  Theme$1['colors']['badge']['text']
->}`;
-
-type BrandPrimaryColors$1 = `brand.primary.${keyof Theme$1['colors']['brand']['primary']}`;
-
-type As$1 =
-  | 'code'
-  | 'h1'
-  | 'h2'
-  | 'h3'
-  | 'h4'
-  | 'h5'
-  | 'h6'
-  | 'p'
-  | 'span'
-  | 'abbr'
-  | 'q'
-  | 'cite'
-  | 'figcaption'
-  | 'div';
-type BaseTextProps$1 = {
-  id?: string;
-  color?:
-    | BrandPrimaryColors$1
-    | ActionColors$1
-    | FeedbackColors$1
-    | SurfaceColors$1
-    | FeedbackActionColors$1
-    | BadgeTextColors$1;
-  fontFamily?: keyof Theme$1['typography']['fonts']['family'];
-  fontSize?: keyof Theme$1['typography']['fonts']['size'];
-  fontWeight?: keyof Theme$1['typography']['fonts']['weight'];
-  fontStyle?: 'italic' | 'normal';
-  textDecorationLine?: 'line-through' | 'none' | 'underline';
-  lineHeight?: keyof Theme$1['typography']['lineHeights'];
-  /**
-   * Web only
-   */
-  as?: As$1;
-  textAlign?: 'center' | 'justify' | 'left' | 'right';
-  truncateAfterLines?: number;
-  className?: string;
-  style?: React.CSSProperties;
-  children: React.ReactNode;
-  accessibilityProps?: Partial<AccessibilityProps>;
-  /**
-   * React Native only
-   */
-  numberOfLines?: number;
-  componentName?: 'base-text' | 'text' | 'title' | 'heading' | 'code';
-} & TestID &
-  StyledPropsBlade$1;
-
 /* eslint-disable @typescript-eslint/no-unnecessary-type-assertion */
 
 
@@ -3430,12 +3444,12 @@ type TextVariant$1 = 'body' | 'caption';
 
 type TextBodyVariant$1 = TextCommonProps$1 & {
   variant?: Extract<TextVariant$1, 'body'>;
-  size?: 'xsmall' | 'small' | 'medium' | 'large';
+  size?: Extract<BaseTextSizes$1, 'xsmall' | 'small' | 'medium' | 'large'>;
 };
 
 type TextCaptionVariant$1 = TextCommonProps$1 & {
   variant?: Extract<TextVariant$1, 'caption'>;
-  size?: 'medium';
+  size?: Extract<BaseTextSizes$1, 'medium'>;
 };
 
 /**
@@ -5354,6 +5368,7 @@ declare type BaseTextProps = {
     numberOfLines?: number;
     componentName?: 'base-text' | 'text' | 'title' | 'heading' | 'code';
 } & TestID & StyledPropsBlade$1;
+declare type BaseTextSizes = 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge';
 
 declare const validAsValues$2: readonly ["span", "h1", "h2", "h3", "h4", "h5", "h6"];
 declare type TitleProps = {
@@ -5364,7 +5379,7 @@ declare type TitleProps = {
      * **Note** This takes priority over `type` and `constrast` prop to decide color of title
      */
     color?: BaseTextProps['color'];
-    size?: 'small' | 'medium' | 'large' | 'xlarge';
+    size?: Extract<BaseTextSizes, 'small' | 'medium' | 'large' | 'xlarge'>;
     contrast?: ColorContrastTypes;
     type?: TextTypes;
     children: React.ReactNode;
@@ -5374,7 +5389,6 @@ declare type TitleProps = {
 declare const Title: ({ as, size, type, contrast, color, children, testID, textAlign, textDecorationLine, ...styledProps }: TitleProps) => ReactElement;
 
 declare type HeadingVariant = 'regular' | 'subheading';
-declare type HeadingSize = 'small' | 'medium' | 'large';
 declare const validAsValues$1: readonly ["span", "h1", "h2", "h3", "h4", "h5", "h6"];
 declare type HeadingCommonProps = {
     as?: typeof validAsValues$1[number];
@@ -5396,7 +5410,7 @@ declare type HeadingNormalVariant = HeadingCommonProps & {
      *
      * @default small
      */
-    size?: HeadingSize;
+    size?: Extract<BaseTextSizes, 'small' | 'medium' | 'large'>;
     weight?: keyof Theme$1['typography']['fonts']['weight'];
 };
 declare type HeadingSubHeadingVariant = HeadingCommonProps & {
@@ -5438,11 +5452,11 @@ declare type TextCommonProps = {
 declare type TextVariant = 'body' | 'caption';
 declare type TextBodyVariant = TextCommonProps & {
     variant?: Extract<TextVariant, 'body'>;
-    size?: 'xsmall' | 'small' | 'medium' | 'large';
+    size?: Extract<BaseTextSizes, 'xsmall' | 'small' | 'medium' | 'large'>;
 };
 declare type TextCaptionVariant = TextCommonProps & {
     variant?: Extract<TextVariant, 'caption'>;
-    size?: 'medium';
+    size?: Extract<BaseTextSizes, 'medium'>;
 };
 /**
  * Conditionally changing props based on variant.
@@ -5472,7 +5486,7 @@ declare type CodeCommonProps = {
      *
      * @default small
      */
-    size?: 'small' | 'medium';
+    size?: Extract<BaseTextSizes, 'small' | 'medium'>;
     weight?: 'regular' | 'bold';
     isHighlighted?: boolean;
     color?: BaseTextProps['color'];
@@ -5557,13 +5571,40 @@ declare type ModalBodyProps = {
 declare const ModalBody: (props: ModalBodyProps) => React__default.ReactElement;
 
 declare type ModalProps = {
-    children: React__default.ReactNode;
+    /**
+     *  Children of Modal
+     * Only ModalHeader, ModalBody and ModalFooter are allowed as children
+     */
+    children: React.ReactNode;
+    /**
+     Sets the modal to open or close
+     * @default false
+     */
     isOpen: boolean;
+    /**
+     *  Callback function when user clicks on close button or outside the modal or on pressing escape key.
+     */
     onDismiss: () => void;
-    initialFocusRef?: React__default.MutableRefObject<any>;
+    /**
+     *  Ref to the element to be focused on opening the modal.
+     */
+    initialFocusRef?: React.MutableRefObject<any>;
+    /**
+     *  Size of the modal
+     * @default 'small'
+     */
     size?: 'small' | 'medium' | 'large';
+    /**
+     *  Accessibility label for the modal
+     */
     accessibilityLabel?: string;
+    /**
+     * Sets the z-index of the modal
+     * @default 1000
+     */
+    zIndex?: number;
 };
+
 declare const Modal: (props: ModalProps) => React__default.ReactElement;
 
 declare type ProgressBarCommonProps = {
@@ -6360,6 +6401,12 @@ declare type BottomSheetProps = {
      * By default the initial focus will go to the close button
      */
     initialFocusRef?: React.MutableRefObject<any>;
+    /**
+     * Sets the z-index of the bottom sheet
+     * Note: when using stacked bottom sheet make sure all the bottom sheets have the same zIndex
+     * @default 100
+     */
+    zIndex?: number;
 };
 declare type BottomSheetHeaderProps = Pick<BaseHeaderProps, 'title' | 'subtitle' | 'leading' | 'showBackButton' | 'onBackButtonClick'> & {
     /**