@ilo-org/react 0.0.17 → 0.1.0

package/lib/types/react/src/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/react/src/components/ReadMore/index.d.ts

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

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

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

package/lib/types/react/src/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/react/src/components/RichText/index.d.ts

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

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

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { SearchFieldProps } from "./SearchField.props";
+declare const SearchField: FC<SearchFieldProps>;
+export default SearchField;

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

@@ -0,0 +1,29 @@
+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/react/src/components/SearchField/index.d.ts

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

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

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

package/lib/types/react/src/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/react/src/components/TableOfContents/index.d.ts

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

package/lib/types/react/src/components/Tag/Tag.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { TagProps } from "./Tag.props";
+declare const Tag: FC<TagProps>;
+export default Tag;

package/lib/types/react/src/components/Tag/Tag.props.d.ts

@@ -0,0 +1,28 @@
+import { ReactNode } from "react";
+import { TagTypes } from "../../types";
+export interface TagProps {
+    /**
+     * Callback to event;
+     */
+    callback?: (e: React.MouseEvent<HTMLButtonElement>) => any;
+    /**
+     * Specify the label for the tag
+     */
+    children?: ReactNode;
+    /**
+     * The tag's unique id.
+     */
+    id: string;
+    /**
+     * Specify an optional className to be added to your Tag.
+     */
+    className?: string;
+    /**
+     * Specify a tag type
+     */
+    type?: TagTypes;
+    /**
+     * Specify an optional url to be added to your Tag.
+     */
+    url?: string;
+}

package/lib/types/react/src/components/Tag/TagCtx.d.ts

@@ -0,0 +1,2 @@
+import { TagSetContextProps } from "./TagSet.props";
+export declare const TagSetContext: import("react").Context<TagSetContextProps>;

package/lib/types/react/src/components/Tag/TagSet.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { TagSetProps } from "./TagSet.props";
+declare const TagSet: FC<TagSetProps>;
+export default TagSet;

package/lib/types/react/src/components/Tag/TagSet.props.d.ts

@@ -0,0 +1,30 @@
+import { Dispatch, ReactElement, SetStateAction } from "react";
+export { default as TagSet } from "./TagSet";
+export interface TagSetProps {
+    /**
+     * Allow multiple tags to be active at once
+     */
+    allowMultipleActive?: boolean;
+    /**
+     * Callback to onButtonClick event;
+     */
+    onButtonClick?: (e: React.MouseEvent<HTMLButtonElement>, i: number) => any;
+    /**
+     * Specify the content of your Tag.
+     */
+    children?: ReactElement<TagSetProps> | ReactElement<TagSetProps>[];
+    /**
+     * Specify an optional className to be added to your accordion.
+     */
+    className?: string;
+    /**
+     * Default Tags that are active
+     */
+    defaultTagActive?: string[];
+}
+export interface TagSetContextProps {
+    activeItems: string[];
+    setActiveItems: Dispatch<SetStateAction<string[]>>;
+    allowMultipleActive: boolean;
+    onButtonClick?: (e: React.MouseEvent<HTMLButtonElement>, i: number) => void;
+}

package/lib/types/react/src/components/Tag/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Tag } from "./Tag";
+export { default as TagSet } from "./TagSet";

package/lib/types/react/src/components/Textarea/Textarea.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { TextareaProps } from "./Textarea.props";
+declare const Textarea: FC<TextareaProps>;
+export default Textarea;

package/lib/types/react/src/components/Textarea/Textarea.props.d.ts

@@ -0,0 +1,59 @@
+export interface TextareaProps {
+    /**
+     * The Textarea's onChange callback.
+     */
+    callback?: (e: React.ChangeEvent<HTMLTextAreaElement>) => any;
+    /**
+     * Specify an optional className to be added to your Textarea.
+     */
+    className?: string;
+    /**
+     * Is the Textarea disabled?
+     */
+    disabled?: boolean;
+    /**
+     * Does the Textarea have an error?
+     */
+    error?: string;
+    /**
+     * The Textarea's helper text
+     */
+    helper?: string;
+    /**
+     * The Textarea's id attribute
+     */
+    id?: string;
+    /**
+     * Does this Textarea have a label?
+     */
+    label: string;
+    /**
+     * The Textarea's maxlength
+     */
+    maxlength?: number;
+    /**
+     * The Textarea's minlength
+     */
+    minlength?: number;
+    /**
+     * The Textarea's name attribute
+     */
+    name?: Required<string>;
+    /**
+     * Specify an optional className to be added to your Textarea component.
+     */
+    placeholder?: string;
+    /**
+     * Specify whether this Textarea is required
+     */
+    required?: boolean;
+    /**
+     * Specify whether this Textarea employs browser-based spellcheck
+     */
+    spellcheck?: boolean;
+    /**
+     * Does this Textarea have a tooltip?
+     */
+    tooltip?: string;
+    type?: never;
+}

package/lib/types/react/src/components/Textarea/index.d.ts

@@ -0,0 +1 @@
+export { default as Textarea } from "./Textarea";

package/lib/types/react/src/components/Tooltip/Tooltip.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { TooltipProps } from "./Tooltip.props";
+declare const Tooltip: FC<TooltipProps>;
+export default Tooltip;

package/lib/types/react/src/components/Tooltip/Tooltip.props.d.ts

@@ -0,0 +1,35 @@
+import { TooltipThemes } from "../../types";
+export interface TooltipProps {
+    /**
+     * Specify an optional className to be added to your Tooltip.
+     */
+    className?: string;
+    /**
+     * Should the tooltip appear on hover of an info icon?
+     */
+    icon?: boolean;
+    /**
+     * Set the label for the tooltip
+     */
+    label?: Required<string>;
+    /**
+     * Set whether the tooltip is visible or not
+     */
+    isVisible?: boolean;
+    /**
+     * Callback fired onMouseOver
+     */
+    onMouseOver?: (e: React.MouseEventHandler<HTMLDivElement>) => any;
+    /**
+     * Callback fired onMouseOut
+     */
+    onMouseOut?: (e: React.MouseEventHandler<HTMLDivElement>) => any;
+    /**
+     * Describe the theme of the tooltip
+     */
+    theme?: Required<TooltipThemes>;
+    /**
+     * Set a width for the tooltip
+     */
+    width?: string;
+}

package/lib/types/react/src/components/Tooltip/index.d.ts

@@ -0,0 +1 @@
+export { default as Tooltip } from "./Tooltip";

package/lib/types/react/src/components/Video/Video.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { VideoProps } from "./Video.props";
+declare const Video: FC<VideoProps>;
+export default Video;

package/lib/types/react/src/components/Video/Video.props.d.ts

@@ -0,0 +1,66 @@
+import { TracksConfig } from "./VideoPlayer.props";
+export interface Poster {
+    url: {
+        src: string;
+    }[];
+    alt: string;
+}
+interface VideoPlayerControls {
+    /**
+     * Specify the label for the fullscreen button
+     */
+    fullscreen?: Required<string>;
+    /**
+     * Specify the label for the  play button
+     */
+    play?: Required<string>;
+    /**
+     * Specify the label for the pause button
+     */
+    pause?: Required<string>;
+    /**
+     * Specify the label for the volume button
+     */
+    volume?: Required<string>;
+}
+interface Video {
+    /**
+     * Specify the strings to be used as labels for the video controls
+     */
+    controls?: Required<VideoPlayerControls | false>;
+    /**
+     * if self-hosted, specify the url of this video
+     */
+    src?: string | null;
+    /**
+     * if there are closed-caption tracks,
+     */
+    tracks?: TracksConfig[];
+    /**
+     * if YouTube, set to true
+     */
+    youtube?: boolean;
+}
+export interface VideoProps {
+    /**
+     * Specify the alt for the image
+     */
+    alt: String;
+    /**
+     * Specify the caption for the image/video
+     */
+    caption?: string;
+    /**
+     * Specify an optional className to be added to your Media.
+     */
+    className?: string;
+    /**
+     * Specify the image src for the image
+     */
+    poster?: Poster;
+    /**
+     * Specify whether there is a video being shown
+     */
+    video: Video;
+}
+export {};

package/lib/types/react/src/components/Video/VideoPlayer.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { VideoPlayerProps } from "./VideoPlayer.props";
+declare const VideoPlayer: FC<VideoPlayerProps>;
+export default VideoPlayer;

package/lib/types/react/src/components/Video/VideoPlayer.props.d.ts

@@ -0,0 +1,67 @@
+import { Poster } from "./Video.props";
+export interface VideoPlayerControls {
+    /**
+     * Specify the label for the fullscreen button
+     */
+    fullscreen: string;
+    /**
+     * Specify the label for the  play button
+     */
+    play: string;
+    /**
+     * Specify the label for the pause button
+     */
+    pause: string;
+    /**
+     * Specify the label for the volume button
+     */
+    volume: string;
+}
+export interface TracksConfig {
+    /**
+     * is this the default track?
+     */
+    default?: boolean;
+    /**
+     * What kind of track is it?
+     */
+    kind?: string;
+    /**
+     * url for the track
+     */
+    src?: string;
+    /**
+     * language of the track
+     */
+    srcLang?: string;
+}
+export interface VideoPlayerProps {
+    /**
+     * Specify an optional className to be added to your Media.
+     */
+    className?: string;
+    /**
+     * Specify the strings to be used as labels for the video controls
+     */
+    controls?: Required<VideoPlayerControls | false>;
+    /**
+     * Specify whether a video is to be shown
+     */
+    hasvideo?: Required<boolean>;
+    /**
+     *  poster image for video
+     */
+    poster?: Poster;
+    /**
+     * if self-hosted, specify the url of this video
+     */
+    src?: string | null;
+    /**
+     * if there are closed-caption tracks,
+     */
+    tracks?: Required<Array<TracksConfig>> | null;
+    /**
+     * if YouTube, set to true
+     */
+    youtube?: boolean;
+}

package/lib/types/react/src/components/Video/index.d.ts

@@ -0,0 +1 @@
+export { default as Video } from "./Video";

package/lib/types/react/src/components/index.d.ts

@@ -0,0 +1,39 @@
+export { Accordion, AccordionButton, AccordionItem, AccordionPanel, } from "./Accordion";
+export { Collapse } from "./Collapse";
+export { Empty } from "./Empty";
+export { FormGroup } from "./FormGroup";
+export { Image } from "./Image";
+export { Loading } from "./Loading";
+export { Radio } from "./Radio";
+export { Tag } from "./Tag";
+export { Button } from "./Button";
+export { ContextMenu } from "./ContextMenu";
+export { Fieldset } from "./Fieldset";
+export { GlobalProvider } from "./GlobalProvider";
+export { Input } from "./Input";
+export { Notification } from "./Notification";
+export { ReadMore } from "./ReadMore";
+export { Textarea } from "./Textarea";
+export { Callout } from "./Callout";
+export { Credit } from "./Credit";
+export { FileUpload } from "./FileUpload";
+export { Heading } from "./Heading";
+export { Link } from "./Link";
+export { NumberPicker } from "./NumberPicker";
+export { RichText } from "./RichText";
+export { Tooltip } from "./Tooltip";
+export { Checkbox } from "./Checkbox";
+export { DatePicker } from "./DatePicker";
+export { Form } from "./Form";
+export { Hero } from "./Hero";
+export { LinkList } from "./LinkList";
+export { Pagination } from "./Pagination";
+export { SearchField } from "./SearchField";
+export { Video } from "./Video";
+export { ChoiceGroup } from "./ChoiceGroup";
+export { Dropdown } from "./Dropdown";
+export { FormElement } from "./FormElement";
+export { Icon } from "./Icon";
+export { List } from "./List";
+export { Profile } from "./Profile";
+export { TableOfContents } from "./TableOfContents";

package/lib/types/react/src/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export { default as useGlobalSettings } from "./useGlobalSettings";
+export { default as useVideoPlayer } from "./useVideoPlayer";

package/lib/types/react/src/hooks/useGlobalSettings.d.ts

@@ -0,0 +1,4 @@
+declare const useGlobalSettings: () => {
+    prefix: string | undefined;
+};
+export default useGlobalSettings;

package/lib/types/react/src/hooks/useVideoPlayer.d.ts

@@ -0,0 +1,12 @@
+declare const useVideoPlayer: (videoElement: any) => {
+    handleOnTimeUpdate: () => void;
+    handleVideoScrub: (event: any) => void;
+    handleVolumeChange: (event: any) => void;
+    playing: boolean;
+    progress: number;
+    showvolume: boolean;
+    toggleFullscreen: () => void;
+    togglePlay: () => void;
+    toggleVolumeSlider: () => void;
+};
+export default useVideoPlayer;

package/lib/types/react/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./components";

package/lib/types/react/src/types/index.d.ts

@@ -0,0 +1,26 @@
+export type ButtonFunctions = "button" | "submit" | "reset";
+export type ButtonTypes = "primary" | "secondary" | "tertiary" | "alert";
+export type CalloutTypes = "info" | "error" | "success" | "warning";
+export type ChoiceGroupFieldTypes = "checkbox" | "radio";
+export type FieldTypes = "checkbox" | "date" | "dropdown" | "formgroup" | "input" | "number" | "radio" | "textarea" | "toggle" | "file";
+export type FormGroupTypes = "default" | "filter";
+export type HeadingLevel = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export type HeroCardAlignment = "left" | "center" | "right";
+export type HeroCardTypes = "home" | "publication" | "graphic" | "project" | "article" | "portal";
+export type HeroCardTheme = "dark" | "light";
+export type InputTypes = "email" | "hidden" | "password" | "search" | "tel" | "text" | "url";
+export type LabelTypes = "default" | "actionable" | "light";
+export type LinkTypes = "light" | "dark" | "footer" | "button";
+export type LinkListThemes = "light" | "dark";
+export type TooltipThemes = "light" | "dark";
+export type TooltipAlignment = "top" | "right" | "bottom" | "left";
+export type TooltipPlacement = "negative" | "center" | "positive";
+export type ListAlignment = "default" | "horizontal";
+export type ListOrder = "unordered" | "ordered" | "unstyled";
+export type LoadingStatus = "idle" | "loading" | "loaded";
+export type LoadingSize = "small" | "large";
+export type NotificationPlacement = "dialog" | "inline";
+export type NotificationTypes = "error" | "info" | "success" | "warning";
+export type PositionTypes = "top" | "bottom" | "left" | "right";
+export type SizeTypes = "small" | "medium" | "large";
+export type TagTypes = "anchor" | "display" | "button";

package/lib/types/react/src/utils/checkArrayDuplicates.d.ts

@@ -0,0 +1 @@
+export declare function checkArrayDuplicates(array: string[]): boolean;

package/lib/types/react/src/utils/createChainedFunction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Safe chained function
+ *
+ * Will only create a new function if needed,
+ * otherwise will pass back existing functions or null.
+ *
+ * @param {function} functions to chain
+ * @returns {function|null}
+ */
+declare function createChainedFunction(...funcs: any[]): any;
+export default createChainedFunction;

package/lib/types/react/src/utils/getDefaultDimensionValue.d.ts

@@ -0,0 +1,3 @@
+type Dimension = "height" | "width";
+export default function getDefaultDimensionValue(dimension: Dimension, elem: HTMLElement): number;
+export {};

package/lib/types/react/src/utils/hoursMinutesSeconds.d.ts

@@ -0,0 +1 @@
+export default function hoursMinutesSeconds(secs: number): string;

package/lib/types/react/src/utils/index.d.ts

@@ -0,0 +1,6 @@
+export { checkArrayDuplicates } from "./checkArrayDuplicates";
+export { default as createChainedFunctions } from "./createChainedFunction";
+export { default as getDefaultDimensionValue } from "./getDefaultDimensionValue";
+export { default as hoursMinutesSeconds } from "./hoursMinutesSeconds";
+export { default as transitionEndListener } from "./transitionEndListener";
+export { default as triggerBrowserReflow } from "./triggerBrowserReflow";

package/lib/types/react/src/utils/transitionEndListener.d.ts

@@ -0,0 +1 @@
+export default function transitionEndListener(element: HTMLElement, handler: (e: TransitionEvent) => void): void;

package/lib/types/react/src/utils/triggerBrowserReflow.d.ts

@@ -0,0 +1 @@
+export default function triggerBrowserReflow(node: HTMLElement): void;