@appbuckets/react-ui-core/generic.d.ts

Core utilities built for AppBuckets React UI Framework

import { Key, ReactNode } from 'react';
import * as React from 'react';
/** Generic Object */
export declare type AnyObject = {
  [key: string]: any;
};
/**
 * Any Content that could be rendered
 * using React
 */
export declare type ShorthandContent = React.ReactNode | React.ElementType;
/**
 * The Component to use to make a Shorthand
 * factory function
 */
export declare type ShorthandedComponent<P> =
  | React.ElementType
  | React.ComponentType<P>;
/**
 * The value that could be passed to a Shorthand factory function
 * If node will be passed, the inner component will reflect node.
 * If props object will be passed, they will be applied to
 * the Shorthanded Component
 */
export declare type ShorthandValue<P> = React.ReactNode | (P & AnyObject);
/**
 * A shorthand item.
 * This type could be used in type declaration
 * to set a prop as a item shorthand generator
 */
export declare type ShorthandItem<P> = ReactNode | P;
export declare type ShorthandCollection<P> = ShorthandItem<
  P & {
    key: Key;
  }
>[];
/**
 * Options that must be passed to shorthand
 * factory function
 */
export interface ShorthandMethodOptions<P> {
  /** Auto Generate Key on Iteration */
  autoGenerateKey: boolean;
  /** Get the Child Key */
  childKey?: (props: P) => React.Key;
  /** Default Props to set */
  defaultProps?: Partial<P>;
  /** Props that override computed ones */
  overrideProps?: Partial<P> | ((props: P) => Partial<P>);
}
/**
 * A creatable function component type is useful
 * to describe React component who has 'create'
 * shorthand method
 */
export declare type CreateFunction<P> = (
  value: ShorthandValue<P>,
  options: ShorthandMethodOptions<P>
) => React.ReactElement<P> | null;
export declare type CreatableFunctionComponent<P> =
  React.FunctionComponent<P> & {
    create: CreateFunction<P>;
  };
/**
 * Augment component props including an
 * optional as type to edit the Element
 * used to render the a Component
 */
export declare type PropsWithAs<P extends {} = {}> =
  React.PropsWithChildren<P> & {
    as?: React.ElementType;
  } & {
    [key: string]: any;
  };