@liner-fe/prism 2.4.1 → 2.4.3

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 import { SystemKeys, breakpointOrigin } from '@liner-fe/design-token';
 import * as react from 'react';
-import react__default, { SVGProps, ButtonHTMLAttributes, RefAttributes, HTMLAttributes, ReactNode, ComponentPropsWithoutRef, InputHTMLAttributes, ComponentProps, LiHTMLAttributes } from 'react';
+import react__default, { SVGProps, ButtonHTMLAttributes, RefAttributes, HTMLAttributes, ReactNode, ComponentPropsWithoutRef, InputHTMLAttributes, ComponentProps, LiHTMLAttributes, MouseEventHandler } from 'react';
 import * as cva from 'cva';
 import { VariantProps } from 'cva';
 import * as react_jsx_runtime from 'react/jsx-runtime';
@@ -8,6 +8,10 @@ import { ToastProps } from '@radix-ui/react-toast';
 import * as _artsy_fresnel_dist_Media from '@artsy/fresnel/dist/Media';
 import { TypographyCaptionPrefix, TypographyParagraphPrefix, TypographyHeadingPrefix, TypographyTitlePrefix, TypographyDisplayPrefix } from '@liner-fe/design-token-primitive';
 import { Popover as Popover$1, Tooltip as Tooltip$1, Checkbox as Checkbox$1, RadioGroup, Slider as Slider$1, Select as Select$1, Label as Label$1 } from 'radix-ui';
+import * as PopoverPrimitive from '@radix-ui/react-popover';
+import { PopoverProps, PopoverPortalProps } from '@radix-ui/react-popover';
+import { ImageProps } from 'next/image';
+import { Property } from 'csstype';
 
 interface IconComponentProps {
     className?: string;
@@ -531,4 +535,92 @@ interface CombinationProps {
 type LogoProps = LogoDefaultProps | CombinationProps;
 declare const Logo: (props: LogoProps) => react_jsx_runtime.JSX.Element;
 
-export { type BasicColorType, type BreakPointsKey, Button, type ButtonIconProps, type ButtonProps, type ButtonSizeType, Caption, Checkbox, type CommonButtonProps, DefaultButton, type DefaultButtonProps, Display, type FillFalseLevelType, type FillLevelType, type FillType, Heading, type ICaptionProps, type IDisplayProps, type IHeadingProps, type IPropsAccent, type IPropsAnswer, type IPropsNormal, type IPropsPost, type ITitleProps, Icon, IconButton, type IconButtonLevelType, type IconButtonProps, type IconColorType, type IconComponent, type IconComponentProps, type IconKey, type IconMapType, type IconProps, type IconSizeKey, type IconSizeType, type ItemProps, Label, List, Loading, Logo, Media, MediaContextProvider, Paragraph, type ParagraphProps, Popover, type PopoverContentProps, Radio, Select, type SelectItemProps, type SelectProps, Slider, TextButton, type TextButtonProps, Textfield, type TextfieldButtonProps, type TextfieldLabelType, type TextfieldProps, Title, Toaster, Tooltip, Typography, arrayToStyleObject, getIconComponent, iconKeyOptions, iconMap, isEmptyObject, objectToArray, rootMediaStyle, useToast };
+type PrimitiveCoachMarkRootProps = PopoverProps & {
+    trigger: ReactNode;
+};
+/**
+ * PrimitiveCoachMark Content
+ * 사용 가능한 속성은 @radix-ui/react-popover 의 PopoverContentProps 참고
+ * https://www.radix-ui.com/primitives/docs/components/popover#content
+ */
+interface PrimitiveCoachMarkContentProps extends PopoverPrimitive.PopoverContentProps, PopoverPortalProps {
+    dim?: boolean;
+}
+/**
+ * @description 커스텀 스타일용 기본 CoachMark 컴포넌트
+ * - Anchor에 색상이 들어가있지 않습니다.
+ * - CoachMarkContent의 className을 통해 span > svg > path의 fill 값을 변경해 사용해주세요.
+ */
+declare const PrimitiveCoachMark: (({ trigger, children, ...props }: PrimitiveCoachMarkRootProps) => react_jsx_runtime.JSX.Element) & {
+    Content: react.ForwardRefExoticComponent<PrimitiveCoachMarkContentProps & react.RefAttributes<HTMLDivElement>>;
+    Portal: react.FC<PopoverPrimitive.PopoverPortalProps>;
+};
+
+interface Step {
+    total: number;
+    current: number;
+}
+interface RestrictedButtonProps {
+    children?: ReactNode;
+    onClick?: MouseEventHandler<HTMLButtonElement>;
+}
+
+type LightIllustType = "hero-gift" | "hero-search" | "mini-documents-2" | "mini-documents-3" | "mini-documents-4" | "mini-documents-5" | "mini-documents" | "mini-egg" | "mini-gift" | "mini-graduation_hat" | "mini-not-search" | "mini-search" | "mini-ticket" | "mini-window" | "spot-catch_star" | "spot-clap" | "spot-empty" | "spot-no_search" | "spot-search-2" | "spot-search-3" | "spot-search-4" | "spot-search-5" | "spot-search" | "spot-write";
+type DarkIllustType = "hero-gift" | "hero-search" | "mini-documents-2" | "mini-documents-3" | "mini-documents-4" | "mini-documents-5" | "mini-documents" | "mini-egg" | "mini-gift" | "mini-graduation_hat" | "mini-not-search" | "mini-search" | "mini-ticket" | "mini-window" | "spot-catch_star" | "spot-clap" | "spot-empty" | "spot-no_search" | "spot-search-2" | "spot-search-3" | "spot-search-4" | "spot-search-5" | "spot-search" | "spot-write";
+type IllustType = DarkIllustType | LightIllustType;
+
+interface Source<T extends false | true = true> {
+    name: IllustType;
+    inverse?: T;
+}
+interface IllustProps extends Omit<ImageProps, 'alt' | 'width' | 'height' | 'fill' | 'src'> {
+    width: number;
+    src: {
+        light: Source<false>;
+        dark?: Source;
+    };
+    margin?: Property.Margin<string>;
+}
+
+type CoachMarkProps = PrimitiveCoachMarkRootProps & {
+    children?: ReactNode;
+};
+interface BaseCoachMarkContentProps extends Omit<PrimitiveCoachMarkContentProps, 'children'> {
+    tag?: string;
+    title?: string;
+    level?: 'brand' | 'inverse-static' | 'inverse';
+    onClose?: () => void;
+}
+type BaseCoachMarkContent = {
+    icon?: Pick<IconProps, 'name' | 'thick' | 'fill'>;
+    description?: string;
+    step?: Step;
+    primaryButton?: RestrictedButtonProps;
+    secondaryButton?: RestrictedButtonProps;
+    width?: number;
+};
+type WithImage = BaseCoachMarkContent & {
+    image: React.ImgHTMLAttributes<HTMLImageElement>;
+    illust?: undefined;
+};
+type WithIllust = BaseCoachMarkContent & {
+    image?: undefined;
+    illust: Omit<IllustProps, 'width'>;
+};
+type WithoutMedia = BaseCoachMarkContent & {
+    image?: undefined;
+    illust?: undefined;
+};
+type CoachMarkContentProps = (WithImage | WithIllust | WithoutMedia) & BaseCoachMarkContentProps;
+declare const CoachMark: ((props: CoachMarkProps) => react_jsx_runtime.JSX.Element) & {
+    Content: react.ForwardRefExoticComponent<CoachMarkContentProps & react.RefAttributes<HTMLDivElement>>;
+    Portal: react.FC<PopoverPrimitive.PopoverPortalProps>;
+};
+
+type CompactCoachMarkProps = PrimitiveCoachMarkRootProps;
+declare const CompactCoachMark: ((props: CompactCoachMarkProps) => react_jsx_runtime.JSX.Element) & {
+    Content: react.ForwardRefExoticComponent<BaseCoachMarkContentProps & react.RefAttributes<HTMLDivElement>>;
+    Portal: react.FC<PopoverPrimitive.PopoverPortalProps>;
+};
+
+export { type BaseCoachMarkContentProps, type BasicColorType, type BreakPointsKey, Button, type ButtonIconProps, type ButtonProps, type ButtonSizeType, Caption, Checkbox, CoachMark, type CoachMarkContentProps, type CommonButtonProps, CompactCoachMark, DefaultButton, type DefaultButtonProps, Display, type FillFalseLevelType, type FillLevelType, type FillType, Heading, type ICaptionProps, type IDisplayProps, type IHeadingProps, type IPropsAccent, type IPropsAnswer, type IPropsNormal, type IPropsPost, type ITitleProps, Icon, IconButton, type IconButtonLevelType, type IconButtonProps, type IconColorType, type IconComponent, type IconComponentProps, type IconKey, type IconMapType, type IconProps, type IconSizeKey, type IconSizeType, type ItemProps, Label, List, Loading, Logo, Media, MediaContextProvider, Paragraph, type ParagraphProps, Popover, type PopoverContentProps, PrimitiveCoachMark, type PrimitiveCoachMarkContentProps, type PrimitiveCoachMarkRootProps, Radio, Select, type SelectItemProps, type SelectProps, Slider, TextButton, type TextButtonProps, Textfield, type TextfieldButtonProps, type TextfieldLabelType, type TextfieldProps, Title, Toaster, Tooltip, Typography, arrayToStyleObject, getIconComponent, iconKeyOptions, iconMap, isEmptyObject, objectToArray, rootMediaStyle, useToast };