@up42/up-components 4.12.0 → 4.14.0

package/dist/esm/types/components/Banner/Banner.d.ts

@@ -23,6 +23,14 @@ export type BannerProps = {
      */
     onDismiss?: ButtonProps['onClick'];
     title: string;
+    /**
+     * The size(height) of the banner.
+     * - 'default': Standard banner height.
+     * - 'slim': Reduced height, intended for use only with the 'inline' variant.
+     *
+     * Note: 'slim' size has a fixed height of '32px' and should be used exclusively with variant='inline' and probably text ellipsis to ensure proper layout and appearance.
+     */
+    size?: 'default' | 'slim';
 } & Omit<AlertProps, 'title' | 'closeText' | 'icon' | 'role' | 'onClose'>;
 /**
  * Documentation: https://up-components.up42.com/?path=/docs/feedback-banner--docs
@@ -49,4 +57,12 @@ export declare const Banner: React.ForwardRefExoticComponent<Omit<{
      */
     onDismiss?: ButtonProps['onClick'];
     title: string;
+    /**
+     * The size(height) of the banner.
+     * - 'default': Standard banner height.
+     * - 'slim': Reduced height, intended for use only with the 'inline' variant.
+     *
+     * Note: 'slim' size has a fixed height of '32px' and should be used exclusively with variant='inline' and probably text ellipsis to ensure proper layout and appearance.
+     */
+    size?: "default" | "slim" | undefined;
 } & Omit<AlertProps, "title" | "role" | "onClose" | "closeText" | "icon">, "ref"> & React.RefAttributes<unknown>>;

package/dist/esm/types/components/FeatureCard/FeatureCard.d.ts

@@ -1,7 +1,8 @@
 import React, { ReactNode } from 'react';
 import { CardProps } from '@mui/material';
+import { BannerProps } from '../Banner/Banner';
 export type FeatureCardProps = CardProps & {
-    banner?: ReactNode;
+    bannerProps?: Omit<BannerProps, 'title' | 'variant'>;
     header?: {
         title: ReactNode;
         actions?: ReactNode;
@@ -27,4 +28,4 @@ export type FeatureCardProps = CardProps & {
      */
     hovered?: boolean;
 };
-export declare const FeatureCard: ({ children, header, footer, banner, isSelectable, selected, isHoverable, hovered, ...props }: FeatureCardProps) => React.JSX.Element;
+export declare const FeatureCard: ({ children, header, footer, bannerProps, isSelectable, selected, isHoverable, hovered, ...props }: FeatureCardProps) => React.JSX.Element;

package/dist/esm/types/components/FeatureFlagCheckbox/FeatureFlagCheckbox.d.ts

@@ -0,0 +1,25 @@
+import React, { SyntheticEvent } from 'react';
+export type FeatureFlagCheckboxProps = {
+    label: string;
+    checked: boolean;
+    /**
+     * Defines if the component should be rendered or not.
+     * Use this prop to indicate if the application is in a development environment.
+     */
+    isDevelopment: boolean;
+    onChange: (event: SyntheticEvent, checked: boolean) => void;
+    onClose?: () => void;
+};
+/**
+ *
+ * Development-only feature toggle component (not for production use).
+ *
+ * **Important**: This component is intended *strictly* for development environments and should not be included in production builds.
+ *
+ * The `FeatureFlagCheckbox` is a temporary UI component used by developers to enable or disable feature flags manually. It renders a labeled checkbox and an optional close button to dismiss the control.
+ *
+ * **Note**: The component is rendered only when the `isDevelopment` prop is set to `true`. It is the responsibility of the consuming application to ensure the provided value is correct so that is only rendered in non-production environments.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/development-featureflagcheckbox--docs
+ */
+export declare function FeatureFlagCheckbox({ label, checked, isDevelopment, onChange, onClose }: FeatureFlagCheckboxProps): React.JSX.Element;

package/dist/esm/types/components/FeatureFlagCheckbox/FeatureFlagCheckbox.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/types/index.d.ts

@@ -51,6 +51,7 @@ export { FeatureCardHeaderActions, type IconAction, type MenuAction, type Featur
 export { StatusLight, type StatusLightProps } from './components/StatusLight/StatusLight';
 export { TagsList, type TagsListProps } from './components/TagsList/TagsList';
 export { EditTagsButton, type EditTagsButtonProps } from './components/EditTagsButton/EditTagsButton';
+export { FeatureFlagCheckbox, type FeatureFlagCheckboxProps, } from './components/FeatureFlagCheckbox/FeatureFlagCheckbox';
 export { DocumentationPopover, type DocumentationPopoverProps, } from './components/DocumentationPopover/DocumentationPopover';
 export { CodeInline, type CodeInlineProps } from './components/CodeInline/CodeInline';
 export { CodeSnippet, type CodeSnippetProps, type CodeSnippetItemProps } from './components/CodeSnippet/CodeSnippet';

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { BoxProps, TextFieldProps, AvatarProps as AvatarProps$1, GridProps, Cont
 export * from '@mui/material';
 import { ThemeProviderProps } from '@mui/material/styles/ThemeProvider';
 import * as React from 'react';
-import React__default, { ReactNode, ElementType } from 'react';
+import React__default, { ReactNode, ElementType, SyntheticEvent } from 'react';
 import { ButtonProps as ButtonProps$1 } from '@mui/material/Button';
 import { TypographyProps as TypographyProps$1 } from '@mui/material/Typography';
 import { DatePickerProps, DateTimePickerProps } from '@mui/x-date-pickers-pro';
@@ -484,6 +484,14 @@ type BannerProps = {
      */
     onDismiss?: ButtonProps['onClick'];
     title: string;
+    /**
+     * The size(height) of the banner.
+     * - 'default': Standard banner height.
+     * - 'slim': Reduced height, intended for use only with the 'inline' variant.
+     *
+     * Note: 'slim' size has a fixed height of '32px' and should be used exclusively with variant='inline' and probably text ellipsis to ensure proper layout and appearance.
+     */
+    size?: 'default' | 'slim';
 } & Omit<AlertProps, 'title' | 'closeText' | 'icon' | 'role' | 'onClose'>;
 /**
  * Documentation: https://up-components.up42.com/?path=/docs/feedback-banner--docs
@@ -510,6 +518,14 @@ declare const Banner: React__default.ForwardRefExoticComponent<Omit<{
      */
     onDismiss?: ButtonProps['onClick'];
     title: string;
+    /**
+     * The size(height) of the banner.
+     * - 'default': Standard banner height.
+     * - 'slim': Reduced height, intended for use only with the 'inline' variant.
+     *
+     * Note: 'slim' size has a fixed height of '32px' and should be used exclusively with variant='inline' and probably text ellipsis to ensure proper layout and appearance.
+     */
+    size?: "default" | "slim" | undefined;
 } & Omit<AlertProps, "title" | "role" | "onClose" | "closeText" | "icon">, "ref"> & React__default.RefAttributes<unknown>>;
 
 type ContactBoxProps = {
@@ -5096,7 +5112,7 @@ declare const Divider: React__default.ForwardRefExoticComponent<Omit<Omit<Divide
 }, "ref"> & React__default.RefAttributes<unknown>>;
 
 type FeatureCardProps = CardProps & {
-    banner?: ReactNode;
+    bannerProps?: Omit<BannerProps, 'title' | 'variant'>;
     header?: {
         title: ReactNode;
         actions?: ReactNode;
@@ -5122,7 +5138,7 @@ type FeatureCardProps = CardProps & {
      */
     hovered?: boolean;
 };
-declare const FeatureCard: ({ children, header, footer, banner, isSelectable, selected, isHoverable, hovered, ...props }: FeatureCardProps) => React__default.JSX.Element;
+declare const FeatureCard: ({ children, header, footer, bannerProps, isSelectable, selected, isHoverable, hovered, ...props }: FeatureCardProps) => React__default.JSX.Element;
 
 type FeatureCardHeaderProps = {
     header: string;
@@ -5216,6 +5232,31 @@ type EditTagsButtonProps = {
 };
 declare function EditTagsButton({ tags, tagPool, onSave, label, tooltip }: EditTagsButtonProps): React__default.JSX.Element;
 
+type FeatureFlagCheckboxProps = {
+    label: string;
+    checked: boolean;
+    /**
+     * Defines if the component should be rendered or not.
+     * Use this prop to indicate if the application is in a development environment.
+     */
+    isDevelopment: boolean;
+    onChange: (event: SyntheticEvent, checked: boolean) => void;
+    onClose?: () => void;
+};
+/**
+ *
+ * Development-only feature toggle component (not for production use).
+ *
+ * **Important**: This component is intended *strictly* for development environments and should not be included in production builds.
+ *
+ * The `FeatureFlagCheckbox` is a temporary UI component used by developers to enable or disable feature flags manually. It renders a labeled checkbox and an optional close button to dismiss the control.
+ *
+ * **Note**: The component is rendered only when the `isDevelopment` prop is set to `true`. It is the responsibility of the consuming application to ensure the provided value is correct so that is only rendered in non-production environments.
+ *
+ * Documentation: https://up-components.up42.com/?path=/docs/development-featureflagcheckbox--docs
+ */
+declare function FeatureFlagCheckbox({ label, checked, isDevelopment, onChange, onClose }: FeatureFlagCheckboxProps): React__default.JSX.Element;
+
 type DocumentationPopoverProps = {
     title: string;
     children: React__default.ReactNode;
@@ -5488,5 +5529,5 @@ type ContextState = {
  */
 declare const useAlert: () => ContextState;
 
-export { Alert, Avatar, Badge, Banner, Button, Checkbox, CodeInline, CodeSnippet, ContactBox, ControlButton, CopyButton, DataGrid, DateTime, Divider, DocumentationPopover, EditTagsButton, EmptyState, FeatureCard, FeatureCardHeader, FeatureCardHeaderActions, FormCheckbox, FormDatePicker, FormDateRangePicker, FormDateRangePickerList, FormDateTimePicker, FormInput, FormRadio, FormSelect, FormSwitch, GridContainer, GridItem, Icon, Illustration, InfoCard, InfoModal, InfoPopover, Input, Link, Loading, Logo, NotFound, PageContainer, PageHeader, Radio, Select, Slider, StatusLight, Switch, Tab, TabGroup, Table, TableBody, TableCell, TableContainer, TableFooter, TableHead, TablePagination, TableRow, TableSortLabel, Tabs, Tag, TagsList, Typography, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, theme, useAlert, useCursorPagination, useDebounce, useQueryParams, useRemotePagination, useToggle };
-export type { AlertProps, AvatarProps, BadgeProps, BannerProps, ButtonProps, CheckboxProps, CodeInlineProps, CodeSnippetItemProps, CodeSnippetProps, ContactBoxProps, ControlButtonProps, CopyButtonProps, CreateAlertProps, CreateSnackbarProps, CursorPaginatedResponse, DatePickerDateType, DateRange, DateTimeProps, DividerProps, DocumentationPopoverProps, EditTagsButtonProps, EmptyStateProps, FeatureCardHeaderActionsProps, FeatureCardHeaderProps, FeatureCardProps, FormCheckboxProps, FormDatePickerProps, FormDateRangePickerListProps, FormDateRangePickerProps, FormDateTimePickerProps, FormInputProps, FormRadioProps, FormSelectProps, FormSwitchProps, GridContainerProps, GridItemProps, IconAction, IconProps$1 as IconProps, IllustrationProps, InfoCardProps, InfoModalProps, InfoPopoverProps, InputProps, LinkProps, LoadingProps, LogoProps, MenuAction, NotFoundProps, PageContainerProps, PageHeaderProps, PaginatedResponse, RadioProps, SelectProps, SliderProps, StatusLightProps, SwitchProps, TabGroupProps, TabProps, TableBodyProps, TableCellProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, TableProps, TableRowProps, TableSortLabelProps, TabsProps, TagProps, TagsListProps, TypographyProps, UseToggleResult };
+export { Alert, Avatar, Badge, Banner, Button, Checkbox, CodeInline, CodeSnippet, ContactBox, ControlButton, CopyButton, DataGrid, DateTime, Divider, DocumentationPopover, EditTagsButton, EmptyState, FeatureCard, FeatureCardHeader, FeatureCardHeaderActions, FeatureFlagCheckbox, FormCheckbox, FormDatePicker, FormDateRangePicker, FormDateRangePickerList, FormDateTimePicker, FormInput, FormRadio, FormSelect, FormSwitch, GridContainer, GridItem, Icon, Illustration, InfoCard, InfoModal, InfoPopover, Input, Link, Loading, Logo, NotFound, PageContainer, PageHeader, Radio, Select, Slider, StatusLight, Switch, Tab, TabGroup, Table, TableBody, TableCell, TableContainer, TableFooter, TableHead, TablePagination, TableRow, TableSortLabel, Tabs, Tag, TagsList, Typography, UpComponentsProvider, capitalize, copyToClipboard, formatDate, formatFileSize, formatNumber, theme, useAlert, useCursorPagination, useDebounce, useQueryParams, useRemotePagination, useToggle };
+export type { AlertProps, AvatarProps, BadgeProps, BannerProps, ButtonProps, CheckboxProps, CodeInlineProps, CodeSnippetItemProps, CodeSnippetProps, ContactBoxProps, ControlButtonProps, CopyButtonProps, CreateAlertProps, CreateSnackbarProps, CursorPaginatedResponse, DatePickerDateType, DateRange, DateTimeProps, DividerProps, DocumentationPopoverProps, EditTagsButtonProps, EmptyStateProps, FeatureCardHeaderActionsProps, FeatureCardHeaderProps, FeatureCardProps, FeatureFlagCheckboxProps, FormCheckboxProps, FormDatePickerProps, FormDateRangePickerListProps, FormDateRangePickerProps, FormDateTimePickerProps, FormInputProps, FormRadioProps, FormSelectProps, FormSwitchProps, GridContainerProps, GridItemProps, IconAction, IconProps$1 as IconProps, IllustrationProps, InfoCardProps, InfoModalProps, InfoPopoverProps, InputProps, LinkProps, LoadingProps, LogoProps, MenuAction, NotFoundProps, PageContainerProps, PageHeaderProps, PaginatedResponse, RadioProps, SelectProps, SliderProps, StatusLightProps, SwitchProps, TabGroupProps, TabProps, TableBodyProps, TableCellProps, TableContainerProps, TableFooterProps, TableHeadProps, TablePaginationProps, TableProps, TableRowProps, TableSortLabelProps, TabsProps, TagProps, TagsListProps, TypographyProps, UseToggleResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@up42/up-components",
-  "version": "4.12.0",
+  "version": "4.14.0",
   "description": "UP42 Component Library",
   "author": "Axel Fuhrmann axel.fuhrmann@up42.com",
   "license": "ISC",