@ilo-org/react 0.17.8 → 0.18.0

package/lib/types/components/Logo/Logo.props.d.ts

@@ -0,0 +1,55 @@
+type LogoSrc = string | {
+    /**
+     * The url of the logo to use with light theme
+     */
+    light: string;
+    /**
+     * The url of the logo to use with dark theme
+     */
+    dark: string;
+};
+export interface LogoProps {
+    /**
+     * The location of the image file
+     */
+    src: LogoSrc;
+    /**
+     * Alt text for the logo
+     */
+    alt: string;
+    /**
+     * The name of the sub-brand if there is one
+     */
+    subbrand?: string;
+    /**
+     * The width of the logo or 'fluid' width
+     */
+    size?: number | "fluid";
+    /**
+     * Styles to be applied to the outermost element
+     */
+    style?: React.CSSProperties;
+    /**
+     * Optional className to be passed to the outermost element of the component
+     */
+    className?: string;
+    /**
+     * Optional destination if the logo is a link
+     */
+    url?: string;
+    /**
+     * Optional target if the logo is a link
+     */
+    target?: "_blank" | "_self" | "_parent" | "_top";
+    /**
+     * Theme of the logo component
+     */
+    theme?: "light" | "dark";
+}
+export interface InnerLogoProps extends LogoProps {
+    /**
+     * The base class of the logo component
+     */
+    baseClass: string;
+}
+export {};

package/lib/types/components/Logo/index.d.ts

@@ -0,0 +1 @@
+export { default as Logo } from './Logo';

package/lib/types/components/LogoGrid/LogoGrid.d.ts

@@ -0,0 +1,5 @@
+import { default as React } from 'react';
+import { LogoGridProps } from './LogoGrid.props';
+
+declare const LogoGrid: React.FC<LogoGridProps>;
+export default LogoGrid;

package/lib/types/components/LogoGrid/LogoGrid.props.d.ts

@@ -0,0 +1,24 @@
+export interface LogoGridItemProps {
+    /**
+     * The label of the logo
+     */
+    label: string;
+    /**
+     * The image src of the logo
+     */
+    src: string | URL;
+    /**
+     * The link of the logo
+     */
+    url?: string;
+}
+export interface LogoGridProps {
+    /**
+     * The logos to display
+     */
+    logos: LogoGridItemProps[];
+    /**
+     * The theme of the logo grid
+     */
+    theme?: "dark" | "light";
+}

package/lib/types/components/LogoGrid/index.d.ts

@@ -0,0 +1 @@
+export { default as LogoGrid } from './LogoGrid';

package/lib/types/components/Navigation/Navigation.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { NavigationProps } from './Navigation.props';
+
+declare const Navigation: FC<NavigationProps>;
+export default Navigation;

package/lib/types/components/Navigation/Navigation.props.d.ts

@@ -0,0 +1,100 @@
+import { LinkProps, ContextMenuProps } from '../ContextMenu/ContextMenu.props';
+import { SearchFieldProps } from '../SearchField/SearchField.props';
+
+export interface NavigationProps {
+    /**
+     * Props for the logo of the Navigation
+     */
+    logo?: Required<string>;
+    /**
+     * Props for the mobile logo of the Navigation
+     */
+    mobilelogo?: Required<string>;
+    /**
+     * Props for the home url of the Navigation
+     */
+    siteurl?: Required<string>;
+    /**
+     * Specify the tagline for the Navigation
+     */
+    tagline?: Required<TaglineProps>;
+    /**
+     * Specify the primary items for the Navigation
+     */
+    primarynav?: Required<PrimaryNavProps>;
+    /**
+     * Specify the secondary items for the Navigation
+     */
+    subnav?: Required<SubNavProps>;
+    /**
+     * Specify the tagline for the Navigation
+     */
+    searchlabel?: string;
+    /**
+     * Specify the searchfield props for the Navigation
+     */
+    searchfield?: SearchFieldProps;
+    /**
+     * Specify the menu label for the Navigation
+     */
+    menulabel?: string;
+    /**
+     * Specify the menu close label for the Navigation
+     */
+    menucloselabel?: string;
+    /**
+     * Specify the language label for the Navigation
+     */
+    languagelabel?: string;
+    /**
+     * Specify the language context menu for the Navigation
+     */
+    languagecontextmenu?: ContextMenuProps;
+}
+interface PrimaryNavProps {
+    /**
+     * Specify the label for Navigation
+     */
+    navlabel?: Required<string>;
+    /**
+     * Specify the close label for mobile Navigation
+     */
+    mobilecloselabel?: Required<string>;
+    /**
+     * Specify the links
+     */
+    items?: Required<Array<LinkProps>>;
+}
+interface SubNavProps {
+    /**
+     * Specify the label for sub Navigation
+     */
+    navlabel?: Required<string>;
+    /**
+     * Specify the button label for sub Navigation
+     */
+    buttonlabel?: Required<string>;
+    /**
+     * Specify the close label for mobile sub Navigation
+     */
+    mobilecloselabel?: Required<string>;
+    /**
+     * Specify the back label for mobile sub Navigation
+     */
+    mobilebacklabel?: Required<string>;
+    /**
+     * Specify the subnav links
+     */
+    items?: Required<Array<LinkProps>>;
+}
+interface TaglineProps {
+    /**
+     * Specify the main tagline text
+     */
+    tag?: Required<string>;
+    /**
+     * Specify the small tagline text
+     */
+    small?: Required<string>;
+}
+export {};

package/lib/types/components/Navigation/index.d.ts

@@ -0,0 +1 @@
+export { default as Navigation } from './Navigation';

package/lib/types/components/Notification/Notification.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { NotificationProps } from './Notification.props';
+
+declare const Notification: FC<NotificationProps>;
+export default Notification;

package/lib/types/components/Notification/Notification.props.d.ts

@@ -0,0 +1,57 @@
+import { NotificationPlacement, NotificationTypes } from '../../types';
+
+interface CTAProps {
+    /**
+     * Specify the label of the CTA
+     */
+    label?: string;
+    /**
+     * Specify the url of the CTA
+     */
+    url?: string;
+}
+interface TimeStampProps {
+    /**
+     * Specify the human-readable time
+     */
+    human?: string;
+    /**
+     * Specify the UNIX timestamp
+     */
+    unix?: string;
+}
+export interface NotificationProps {
+    /**
+     * Specify an optional className to be added to your Notification component.
+     */
+    className?: string;
+    /**
+     * Specify the label for the close button
+     */
+    closelabel?: Required<string>;
+    /**
+     * Specify the copy
+     */
+    copy?: Required<string>;
+    /**
+     * Specify the settings for an option CTA
+     */
+    cta?: CTAProps;
+    /**
+     * Specify the headline
+     */
+    headline?: Required<string>;
+    /**
+     * Specify whether the notification is inline in the DOM or absolutely-positioned at a higher z-index
+     */
+    placement?: Required<NotificationPlacement>;
+    /**
+     * Specify an optional timestamp
+     */
+    timestamp?: TimeStampProps;
+    /**
+     * Specify the icon for the Notification
+     */
+    type?: NotificationTypes;
+}
+export {};

package/lib/types/components/Notification/index.d.ts

@@ -0,0 +1 @@
+export { default as Notification } from './Notification';

package/lib/types/components/NumberPicker/NumberPicker.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { NumberPickerProps } from './NumberPicker.props';
+
+declare const LabelledNumberPicker: React.ForwardRefExoticComponent<NumberPickerProps & import('../FormControl/FormControl.props').FormControlPublicProps & {
+    inputStyle?: React.CSSProperties | undefined;
+} & React.RefAttributes<HTMLInputElement>>;
+export default LabelledNumberPicker;

package/lib/types/components/NumberPicker/NumberPicker.props.d.ts

@@ -0,0 +1,21 @@
+import { FormFieldProps, LabelledFormFieldProps } from '../../types';
+
+export interface NumberPickerProps extends FormFieldProps<HTMLInputElement> {
+    /**
+     * The placeholder text when the input is empty.
+     */
+    placeholder?: string;
+    /**
+     * The minimum value of the input.
+     */
+    min?: number;
+    /**
+     * The maximum value of the input.
+     * */
+    max?: number;
+    /**
+     * The step value of the input.
+     * */
+    step?: number;
+}
+export type LabelledNumberPickerProps = LabelledFormFieldProps<NumberPickerProps>;

package/lib/types/components/NumberPicker/index.d.ts

@@ -0,0 +1 @@
+export { default as NumberPicker } from './NumberPicker';

package/lib/types/components/Pagination/Pagination.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { PaginationProps } from './Pagination.props';
+
+declare const Pagination: FC<PaginationProps>;
+export default Pagination;

package/lib/types/components/Pagination/Pagination.props.d.ts

@@ -0,0 +1,54 @@
+export interface PaginationProps {
+    /**
+     * Specify the callback of your Button.
+     */
+    callback: (e: React.MouseEvent<Element, MouseEvent>) => any;
+    /**
+     * Specify an optional className to be added to your Pagination component.
+     */
+    className?: string;
+    /**
+     * current page number that the user is on, zero-indexed
+     */
+    currentPage: number;
+    /**
+     * link to the first page
+     */
+    firstPageUrl: string;
+    /**
+     * title label for the first page
+     */
+    firstPageTitle: string;
+    /**
+     * link to the last page
+     */
+    lastPageUrl: string;
+    /**
+     * title label for the last page
+     */
+    lastPageTitle: string;
+    /**
+     * linking word for the page counts
+     */
+    pageCountPreposition?: string;
+    /**
+     * link the following page
+     */
+    nextPageUrl: string;
+    /**
+     * title label for the next page
+     */
+    nextPageTitle: string;
+    /**
+     * link of the previous page
+     */
+    prevPageUrl: string;
+    /**
+     * title label for the prev page
+     */
+    prevPageTitle: string;
+    /**
+     * total number of pages that are available
+     */
+    totalPages: number;
+}

package/lib/types/components/Pagination/index.d.ts

@@ -0,0 +1 @@
+export { default as Pagination } from './Pagination';

package/lib/types/components/Profile/Profile.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { ProfileProps } from './Profile.props';
+
+declare const Profile: FC<ProfileProps>;
+export default Profile;

package/lib/types/components/Profile/Profile.props.d.ts

@@ -0,0 +1,47 @@
+import { ThemeTypes, SizeTypes } from '../../types';
+
+interface LinkProps {
+    /**
+     * Specify the label for the the Profile's link
+     */
+    label?: Required<string>;
+    /**
+     * Specify the url for the Profile's link
+     */
+    url?: Required<string>;
+}
+export interface ProfileProps {
+    /**
+     * Specify the theme for your profile component.
+     */
+    theme?: ThemeTypes;
+    /**
+     * Specify the size for your profile component.
+     */
+    size?: SizeTypes;
+    /**
+     * Specify an optional avatar to be added to your Profile component. Image *must* be a perfect square. CMS backend should provide a fallback if the avatar is not populated.
+     */
+    avatar?: Required<string>;
+    /**
+     * Specify an optional className to be added to your Profile component.
+     */
+    className?: string;
+    /**
+     * Specify an optional description to be added to your Profile component.
+     */
+    description?: string;
+    /**
+     * Specify an optional link to be added to your Profile component.
+     */
+    link?: LinkProps;
+    /**
+     * Specify the name to be added to your Profile component.
+     */
+    name?: Required<string>;
+    /**
+     * Specify an optional role to be added to your Profile component.
+     */
+    role?: string;
+}
+export {};

package/lib/types/components/Profile/index.d.ts

@@ -0,0 +1 @@
+export { default as Profile } from './Profile';

package/lib/types/components/Radio/Radio.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { RadioProps } from './Radio.props';
+
+declare const LabelledRadio: React.ForwardRefExoticComponent<RadioProps & import('../FormControl/FormControl.props').FormControlPublicProps & {
+    inputStyle?: React.CSSProperties | undefined;
+} & React.RefAttributes<HTMLInputElement>>;
+export default LabelledRadio;

package/lib/types/components/Radio/Radio.props.d.ts

@@ -0,0 +1,4 @@
+import { ChoiceFieldProps, LabelledFormFieldProps } from '../../types';
+
+export type RadioProps = ChoiceFieldProps<HTMLInputElement>;
+export type LabelledRadioProps = LabelledFormFieldProps<RadioProps>;

package/lib/types/components/Radio/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Radio } from './Radio';
+export { default as RadioArgs } from './Radio.args';

package/lib/types/components/ReadMore/ReadMore.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { ReadMoreProps } from './ReadMore.props';
+
+declare const ReadMore: FC<ReadMoreProps>;
+export default ReadMore;

package/lib/types/components/ReadMore/ReadMore.props.d.ts

@@ -0,0 +1,32 @@
+export interface ReadMoreButtonLabelProps {
+    /**
+     * Specify the label for the closed state of the "Read More" button
+     */
+    closed?: Required<string>;
+    /**
+     * Specify the label for the opened state of the "Read More" button
+     */
+    opened?: Required<string>;
+}
+export interface ReadMoreProps {
+    /**
+     * Specify labels for the "Read More" button.
+     */
+    buttonlabel?: Required<ReadMoreButtonLabelProps>;
+    /**
+     * Specify an optional className to be added to your Button.
+     */
+    className?: string;
+    /**
+     * Specify the excerpt text
+     */
+    excerpt: string;
+    /**
+     * Specify the complete text
+     */
+    fulltext: string;
+    /**
+     * Specify the open/closed state on component load
+     */
+    openatstart?: boolean;
+}

package/lib/types/components/ReadMore/index.d.ts

@@ -0,0 +1 @@
+export { default as ReadMore } from './ReadMore';

package/lib/types/components/RichText/RichText.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { RichTextProps } from './RichText.props';
+
+declare const RichText: FC<RichTextProps>;
+export default RichText;

package/lib/types/components/RichText/RichText.props.d.ts

@@ -0,0 +1,10 @@
+export interface RichTextProps {
+    /**
+     * Specify an optional className to be added to your RichText.
+     */
+    className?: string;
+    /**
+     * Specify the html content
+     */
+    content: string;
+}

package/lib/types/components/RichText/index.d.ts

@@ -0,0 +1 @@
+export { default as RichText } from './RichText';

package/lib/types/components/SearchField/SearchField.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { SearchFieldProps } from './SearchField.props';
+
+declare const SearchField: FC<SearchFieldProps & React.RefAttributes<HTMLInputElement>>;
+export default SearchField;

package/lib/types/components/SearchField/SearchField.props.d.ts

@@ -0,0 +1,30 @@
+import { InputProps } from '../Input/Input.props';
+
+export interface ButtonProps {
+    /**
+     * The button's label.
+     */
+    label: Required<string>;
+}
+export interface SearchFieldProps {
+    /**
+     * Specify the action attribute for the search form
+     */
+    action?: string;
+    /**
+     * Specify the properties of the submit button
+     */
+    button?: Required<ButtonProps>;
+    /**
+     * The search field submit button's click function.
+     */
+    callback?: (e: React.MouseEvent<HTMLInputElement, MouseEvent>) => any;
+    /**
+     * Specify an optional className to be added to your Button.
+     */
+    className?: string;
+    /**
+     * Specify the properties of the search field input
+     */
+    input?: InputProps;
+}

package/lib/types/components/SearchField/index.d.ts

@@ -0,0 +1 @@
+export { default as SearchField } from './SearchField';

package/lib/types/components/SocialMedia/SocialMedia.d.ts

@@ -0,0 +1,4 @@
+import { SocialMediaProps } from './SocialMedia.props';
+
+declare const SocialMedia: React.FC<SocialMediaProps>;
+export default SocialMedia;

package/lib/types/components/SocialMedia/SocialMedia.props.d.ts

@@ -0,0 +1,42 @@
+import { SocialTypes } from '../../types';
+
+export interface SocialMediaIcons {
+    /**
+     * The name of the icon to display
+     */
+    icon: SocialTypes;
+    /**
+     * The url to link to
+     */
+    url: string;
+    /**
+     * The alt text of the link
+     */
+    label: string;
+}
+export interface SocialMediaProps {
+    /**
+     * An optional headline to display above the icons
+     */
+    headline?: string;
+    /**
+     * Specify an optional className to be added to your SocialMedia.
+     */
+    className?: string;
+    /**
+     * Specify the theme of the SocialMedia.
+     */
+    theme?: "light" | "dark";
+    /**
+     * The justification of the icons
+     */
+    justify?: "start" | "center";
+    /**
+     * Specify the icons to display.
+     */
+    icons: SocialMediaIcons[];
+    /**
+     * The size of the social media icons
+     */
+    iconSize: "normal" | "large";
+}

package/lib/types/components/SocialMedia/index.d.ts

@@ -0,0 +1,3 @@
+export { default as SocialMedia } from './SocialMedia';
+export type { SocialMediaProps } from './SocialMedia.props';
+export { defaultArgs } from './SocialMedia.args';

package/lib/types/components/TableOfContents/TableOfContents.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { TableOfContentsProps } from './TableOfContents.props';
+
+declare const TableOfContents: FC<TableOfContentsProps>;
+export default TableOfContents;

package/lib/types/components/TableOfContents/TableOfContents.props.d.ts

@@ -0,0 +1,20 @@
+export interface AnchorLink {
+    /**
+     * Specify the label for the anchor link
+     */
+    label?: Required<string>;
+    /**
+     * Specify the href for the anchor link
+     */
+    href?: Required<string>;
+}
+export interface TableOfContentsProps {
+    /**
+     * Specify an optional className to be added to your accordion.
+     */
+    className?: string;
+    /**
+     * Specify the items in the table of contents
+     */
+    items?: Required<Array<AnchorLink>>;
+}

package/lib/types/components/TableOfContents/index.d.ts

@@ -0,0 +1 @@
+export { default as TableOfContents } from './TableOfContents';

package/lib/types/components/Tabs/Tabs.args.d.ts

@@ -0,0 +1,11 @@
+import { TabsProps } from './Tabs.props';
+
+/**
+ * Sample prop definitions for Button's enumerable properties (imported in stories and tests).
+ */
+declare const TabsArgs: {
+    tabs: TabsProps;
+    withIcon: TabsProps;
+    fiveItems: TabsProps;
+};
+export default TabsArgs;

package/lib/types/components/Tabs/Tabs.d.ts

@@ -0,0 +1,5 @@
+import { FC } from 'react';
+import { TabsProps } from './Tabs.props';
+
+declare const Tabs: FC<TabsProps>;
+export default Tabs;