@northlight/ui 2.18.2 → 2.19.0

package/dist/es/northlight.d.ts

@@ -864,7 +864,6 @@ interface DatePickerSettings {
     isClearable?: boolean;
     variant?: 'outline' | 'filled';
 }
-type DatePickerMode = 'simple' | 'advanced';
 interface DatePickerProps extends AriaDatePickerProps<DateValue>, DatePickerSettings {
 }
 interface DateRangePickerProps extends Omit<AriaDateRangePickerProps<DateValue>, 'onChange' | 'value' | 'minValue' | 'maxValue'>, DatePickerSettings {
@@ -874,7 +873,6 @@ interface DateRangePickerProps extends Omit<AriaDateRangePickerProps<DateValue>,
     maxValue?: string | undefined;
     fiscalStartMonth?: number;
     fiscalStartDay?: number;
-    mode?: DatePickerMode;
 }
 interface DatePickerFieldProps extends Omit<InputProps, 'onChange'>, InputFieldProps {
     name: string;
@@ -892,7 +890,6 @@ interface DatePickerFieldProps extends Omit<InputProps, 'onChange'>, InputFieldP
 }
 interface DateRangePickerFieldProps extends Omit<DatePickerFieldProps, 'onChange'> {
     onChange?: (date: null | DateRange) => void;
-    mode?: DatePickerMode;
 }
 type FormBody = Record<string, DateRange>;
 
@@ -958,7 +955,7 @@ declare const DatePicker: (props: DatePickerProps) => JSX.Element;
  * field for appropiate use)
  * (?
  * <Form initialValues={{date: null}}>
-  * <DateRangePickerField name="date"/>
+ * <DateRangePickerField name="date"/>
  * </Form>
  * ?)
  *
@@ -968,7 +965,7 @@ declare const DatePicker: (props: DatePickerProps) => JSX.Element;
  * for which we call advance, this one is a simpler version with the same core functionality:
  * (?
  * <Form initialValues={{date: null}}>
-  * <DateRangePickerField name="date" mode="simple"/>
+ * <DateRangePickerField name="date" />
  * </Form>
  * ?)
  *
@@ -977,16 +974,16 @@ declare const DatePicker: (props: DatePickerProps) => JSX.Element;
  * The `DateRangePickerField` can have **fiscalStartMonth** and **fiscalStartDay** as a `number`
  * (?
  * <Form initialValues={{date: null}}>
-  * <DateRangePickerField
-  * name="date"
-  * mode="advanced"
-  * variant="filled"
-  * fiscalStartMonth={3}
-  * fiscalStartDay={5}
-  * dateFormat="mm|dd-yyyy"
-  * minValue="2023-01-01"
-  * maxValue="2028-01-01"
-  * />
+ * <DateRangePickerField
+ * name="date"
+ * mode="advanced"
+ * variant="filled"
+ * fiscalStartMonth={3}
+ * fiscalStartDay={5}
+ * dateFormat="mm|dd-yyyy"
+ * minValue="2023-01-01"
+ * maxValue="2028-01-01"
+ * />
  * </Form>
  * ?)
  */
@@ -2620,7 +2617,7 @@ interface NotificationIconButtonProps extends IconButtonProps$1 {
  */
 declare const NotificationIconButton: (props: NotificationIconButtonProps & React__default.RefAttributes<unknown>) => React__default.ReactElement<any, string | React__default.JSXElementConstructor<any>> | null;
 
-type PinVariant = 'green' | 'yellow' | 'gray' | 'red';
+type PinVariant = 'green' | 'running' | 'yellow' | 'inProgress' | 'gray' | 'notExecuted' | 'red' | 'rejected';
 type PinSize = 'sm' | 'md' | 'lg';
 type PinSizeTuple = [number, number];
 interface PinInputProps extends PinInputProps$1 {
@@ -3390,7 +3387,25 @@ interface StatusPinProps {
  * @see {@link https://northlight/reference/status-pin}
  *
  * @example
- * (? <StatusPin variant="green" /> ?)
+ * (?
+ * +
+ * const variants = ["running", "inProgress", "notExecuted", "rejected"]
+ * const sizes = ["sm", "md", "lg"]
+ * const Example = () => {
+ *     return <Stack>
+ *         { sizes.map((size) => (
+ *         <HStack spacing={ 4 }>
+ *             {
+ *                 variants.map((variant) => (
+ *                 <StatusPin variant={variant} size={size} />
+ *                 ))
+ *             }
+ *             </HStack>
+ *         ))}
+ *         </Stack>
+ * }
+ * render(<Example/>)
+ * ?)
  *
  */
 declare const StatusPin: ({ size, variant }: StatusPinProps) => JSX.Element;