@up42/up-components 0.8.1 → 0.8.3

package/dist/cjs/types/components/Chip/Chip.d.ts

@@ -2,4 +2,7 @@
 import { ChipProps as MUIChipProps } from '@mui/material';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type ChipProps = MUIGlobalOmit<Omit<MUIChipProps, 'size'>>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-chip
+ */
 export declare const Chip: ({ label, ...props }: ChipProps) => JSX.Element;

package/dist/cjs/types/components/CodeBox/CodeBox.d.ts

@@ -3,4 +3,7 @@ export interface CodeBoxProps {
     text: string;
     label?: string;
 }
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-codebox
+ */
 export declare const CodeBox: ({ label, text }: CodeBoxProps) => JSX.Element;

package/dist/cjs/types/components/Container/Container.d.ts

@@ -23,5 +23,7 @@ export declare type ContainerProps = MUIGlobalOmit<Omit<MUIContainerProps, 'maxW
  * - `fluid`: full width (maps).
  *
  * To now more about the requirements please check here: https://up42.atlassian.net/browse/B2B-215.
+ *
+ * Documentation: https://up-components.up42.dev/?path=/docs/layout-container
  */
 export declare const Container: ({ component, size, children, ...props }: ContainerProps) => JSX.Element;

package/dist/cjs/types/components/DataGrid/DataGrid.d.ts

@@ -3,4 +3,7 @@ import { DataGridProps as MuiDataGridProps } from '@mui/x-data-grid';
 export { type GridColDef, type GridRowId, type GridSelectionModel } from '@mui/x-data-grid';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type DataGridProps = MUIGlobalOmit<MuiDataGridProps>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-datagrid
+ */
 export declare const DataGrid: ({ autoHeight, rowsPerPageOptions, disableSelectionOnClick, ...props }: MuiDataGridProps) => JSX.Element;

package/dist/cjs/types/components/EmptyState/EmptyState.d.ts

@@ -18,4 +18,7 @@ export declare type EmptyStateProps<C extends React.ElementType = 'div'> = BaseP
      */
     action?: ReactNode;
 }>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-emptystate
+ */
 export declare const EmptyState: <C extends React.ElementType<any>>({ icon: Icon, title, subTitle, action, ...props }: EmptyStateProps<C>) => JSX.Element;

package/dist/cjs/types/components/Input/Input.d.ts

@@ -1,4 +1,7 @@
 /// <reference types="react" />
 import { TextFieldProps } from '@mui/material';
 export declare type InputProps = Omit<TextFieldProps, 'maxRows' | 'minRows' | 'multiline' | 'rows' | 'size' | 'variant'>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-entry-input
+ */
 export declare const Input: ({ type, ...props }: InputProps) => JSX.Element;

package/dist/cjs/types/components/Loading/Loading.d.ts

@@ -10,4 +10,7 @@ export declare type LoadingProps = {
      */
     visible?: boolean;
 } & BoxProps;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-loading
+ */
 export declare const Loading: ({ fullPage, visible, ...rest }: LoadingProps) => JSX.Element | null;

package/dist/cjs/types/components/NotFound/NotFound.d.ts

@@ -1,2 +1,5 @@
 /// <reference types="react" />
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-notfound
+ */
 export declare const NotFound: () => JSX.Element;

package/dist/cjs/types/components/Radio/Radio.d.ts

@@ -2,4 +2,7 @@
 import { RadioProps as MUIRadioProps } from '@mui/material';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type RadioProps = MUIGlobalOmit<MUIRadioProps>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-entry-radio
+ */
 export declare const Radio: (props: RadioProps) => JSX.Element;

package/dist/cjs/types/components/Select/Select.d.ts

@@ -2,4 +2,7 @@
 import { SelectProps as MUISelectProps } from '@mui/material';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type SelectProps = MUIGlobalOmit<Omit<MUISelectProps, 'variant' | 'label'>>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-entry-select
+ */
 export declare const Select: (props: SelectProps) => JSX.Element;

package/dist/cjs/types/components/Switch/Switch.d.ts

@@ -2,4 +2,7 @@
 import { SwitchProps as MUISwitchProps } from '@mui/material';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type SwitchProps = MUIGlobalOmit<MUISwitchProps>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-entry-switch
+ */
 export declare const Switch: (props: SwitchProps) => JSX.Element;

package/dist/cjs/types/components/TabGroup/TabGroup.d.ts

@@ -14,5 +14,8 @@ export declare type TabGroupProps = {
      */
     nameSpace?: string;
 };
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/patterns-tabgroup
+ */
 export declare const TabGroup: ({ tabs, nameSpace: _nameSpace, tabContentProps, tabsProps }: TabGroupProps) => JSX.Element;
 export {};

package/dist/cjs/types/components/Table/Table.d.ts

@@ -10,6 +10,9 @@ import { TableSortLabelProps as MuiTableSortLabelProps } from '@mui/material/Tab
 import { TableFooterProps as MuiTableFooterProps } from '@mui/material/TableFooter';
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type TableProps = MUIGlobalOmit<MuiTableProps>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-table
+ */
 export declare const Table: ({ children, ...props }: TableProps) => JSX.Element;
 export declare type TableBodyProps = MUIGlobalOmit<MuiTableBodyProps>;
 export declare const TableBody: ({ children, ...props }: TableBodyProps) => JSX.Element;

package/dist/cjs/types/components/Tabs/Tabs.d.ts

@@ -3,5 +3,8 @@ import { TabsProps as MuiTabsProps, TabProps as MuiTabProps } from '@mui/materia
 import { MUIGlobalOmit } from '@global/utils/types';
 export declare type TabsProps = MUIGlobalOmit<MuiTabsProps>;
 export declare type TabProps = MUIGlobalOmit<MuiTabProps>;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/navigation-tabs
+ */
 export declare const Tabs: ({ children, ...props }: TabsProps) => JSX.Element;
 export declare const Tab: ({ children, ...props }: TabProps) => JSX.Element;

package/dist/cjs/types/components/Typography/Typography.d.ts

@@ -4,6 +4,10 @@ export declare type TypographyProps<C extends React.ElementType = 'p'> = MUITypo
     component?: C;
     innerRef?: TypographyProps['ref'];
 }>;
+/**
+ * Tokens: https://up-components.up42.dev/?path=/docs/tokens-typography
+ * Documentation: https://up-components.up42.dev/?path=/docs/data-display-typography
+ */
 export declare const Typography: React.ForwardRefExoticComponent<Pick<{
     component?: React.ElementType<any> | undefined;
     innerRef?: TypographyProps['ref'];

package/dist/cjs/types/global/icons/index.d.ts

@@ -49,6 +49,8 @@ export { default as WeatherCloud } from './weather-cloud.svg';
 export { default as Webhooks } from './webhooks.svg';
 export { default as Workflow } from './workflow.svg';
 export { default as ModuleThree } from './module-three.svg';
+export { default as AlarmBell } from './alarm-bell.svg';
+export { default as Tag } from './tag.svg';
 export { default as Brightness1 } from '@mui/icons-material/Brightness1';
 export { default as ArrowDownward } from '@mui/icons-material/ArrowDownward';
 export { default as ArrowUpward } from '@mui/icons-material/ArrowUpward';

package/dist/cjs/types/global/providers/AlertProvider/AlertProvider.d.ts

@@ -18,5 +18,8 @@ declare type ContextState = {
 export declare const AlertProvider: ({ children }: {
     children: ReactNode;
 }) => JSX.Element;
+/**
+ * Documentation: https://up-components.up42.dev/?path=/docs/feedback-alert-usealert--create-alert
+ */
 export declare const useAlert: () => ContextState;
 export {};

package/dist/cjs/types/global/providers/UpComponentsProvider/UpComponentsProvider.d.ts

@@ -1,3 +1,6 @@
 /// <reference types="react" />
 import { ThemeProviderProps } from '@mui/material/styles/ThemeProvider';
+/**
+ * Documentation: https://up-components.up42.dev/?path=/story/introduction
+ */
 export declare const UpComponentsProvider: (props: Omit<ThemeProviderProps, 'theme'>) => JSX.Element;

package/dist/cjs/types/utils/helpers/capitalize.d.ts

@@ -2,5 +2,7 @@
  * It should to be noted that this helper isn't equivalent to `text-transform: capitalize`.
  * A strict capitalization should uppercase the first letter of each word in the sentence.
  * This helper only handles the first word.
+ *
+ * Documentation: https://up-components.up42.dev/?path=/story/utils--page#capitalize
  */
 export declare const capitalize: (string: string) => string;

package/dist/cjs/types/utils/helpers/copyToClipboard.d.ts

@@ -1 +1,4 @@
+/**
+ * Documentation: https://up-components.up42.dev/?path=/story/utils--page#copytoclipboard
+ */
 export declare const copyToClipboard: (text: string, successCallBack: () => void) => void;

package/dist/cjs/types/utils/hooks/useQueryParams.d.ts

@@ -1,5 +1,7 @@
 /**
  * Returns query parameter values from a string or an array of strings.
+ *
+ * Documentation: https://up-components.up42.dev/?path=/story/utils--page#usequeryparams
  */
 export declare function useQueryParams(paramName: string): string;
 export declare function useQueryParams(paramNames: string[]): Array<string>;

package/dist/cjs/types/utils/hooks/useRemotePagination.d.ts

@@ -18,6 +18,8 @@ declare type UseRemotePaginationResponse = {
 };
 /**
  * Returns pagination data and and helper functions.
+ *
+ * Documentation: https://up-components.up42.dev/?path=/story/utils--page#useremotepagination
  */
 export declare const useRemotePagination: (fetchingHook: ({ params }: {
     params: string;