@paygreen/pgui 2.0.0 → 2.1.2

package/dist/index.d.ts

@@ -0,0 +1,233 @@
+import React, { FC, ReactNode } from 'react';
+import * as _chakra_ui_react from '@chakra-ui/react';
+import { IconButtonProps, FlexProps, AccordionProps, FormControlProps, StackProps, InputProps, BoxProps } from '@chakra-ui/react';
+import * as react_select_dist_declarations_src_useStateManager from 'react-select/dist/declarations/src/useStateManager';
+import * as react_select from 'react-select';
+import { GroupBase, Props } from 'react-select';
+import * as react_select_dist_declarations_src_filters from 'react-select/dist/declarations/src/filters';
+import * as react_select_dist_declarations_src_components from 'react-select/dist/declarations/src/components';
+import * as react_select_dist_declarations_src_Select from 'react-select/dist/declarations/src/Select';
+
+declare type ActionsButtonProps = Omit<IconButtonProps, 'aria-label'> & {
+    label: string;
+};
+declare const ActionsButton: FC<React.PropsWithChildren<ActionsButtonProps>>;
+
+declare type DataListColumns = Record<string, DataListCellProps>;
+declare type DataListContextValue = {
+    setColumns: React.Dispatch<React.SetStateAction<DataListColumns>>;
+    columns: DataListColumns;
+    isHover: boolean;
+};
+declare const DataListContext: React.Context<DataListContextValue>;
+declare const DataListHeaderContext: React.Context<boolean>;
+declare type DataListCellProps = FlexProps & {
+    colName?: string;
+    colWidth?: string | number | Record<string, string | number>;
+    isVisible?: boolean | boolean[] | Record<string, boolean>;
+};
+declare const DataListCell: ({ children, colName, colWidth, isVisible, ...rest }: DataListCellProps) => JSX.Element | null;
+declare const DataListAccordion: ({ ...rest }: {
+    [x: string]: any;
+}) => JSX.Element;
+declare const DataListAccordionButton: ({ ...rest }: {
+    [x: string]: any;
+}) => JSX.Element;
+declare const DataListAccordionIcon: ({ ...rest }: {
+    [x: string]: any;
+}) => JSX.Element;
+declare const DataListAccordionPanel: ({ ...rest }: {
+    [x: string]: any;
+}) => JSX.Element;
+declare type DataListRowProps = FlexProps & {
+    isVisible?: boolean | boolean[] | Record<string, boolean>;
+    isDisabled?: boolean;
+};
+declare const DataListRow: FC<React.PropsWithChildren<DataListRowProps>>;
+declare type DataListHeaderProps = DataListRowProps;
+declare const DataListHeader: FC<React.PropsWithChildren<DataListHeaderProps>>;
+declare type DataListFooterProps = DataListRowProps;
+declare const DataListFooter: FC<React.PropsWithChildren<DataListFooterProps>>;
+declare type DataListProps = AccordionProps & {
+    isHover?: boolean;
+};
+declare const DataList: FC<React.PropsWithChildren<DataListProps>>;
+
+declare type FormGroupProps = Omit<FormControlProps, 'onChange' | 'defaultValue' | 'label'> & {
+    children?: ReactNode;
+    errorMessage?: ReactNode;
+    helper?: ReactNode;
+    id?: string;
+    isRequired?: boolean;
+    label?: ReactNode;
+    showError?: boolean;
+};
+declare const FormGroup: ({ children, errorMessage, helper, id, isRequired, label, showError, ...props }: FormGroupProps) => JSX.Element;
+
+declare const getPaginationInfo: ({ page, pageSize, totalItems, }: {
+    page?: number | undefined;
+    pageSize?: number | undefined;
+    totalItems?: number | undefined;
+}) => {
+    firstPage: number;
+    lastPage: number;
+    firstItemOnPage: number;
+    lastItemOnPage: number;
+    isFirstPage: boolean;
+    isLastPage: boolean;
+};
+declare type PaginationContextValue<PageType = number> = {
+    page: PageType;
+    setPage: (page: PageType) => void;
+    firstPage: PageType;
+    isFirstPage: boolean;
+    lastPage: PageType;
+    isLastPage: boolean;
+    totalItems: number;
+    isLoadingPage: boolean;
+    pageSize: number;
+    firstItemOnPage: number;
+    lastItemOnPage: number;
+};
+declare const PaginationContext: React.Context<PaginationContextValue<number>>;
+declare const PaginationButtonFirstPage: FC<React.PropsWithChildren<Omit<IconButtonProps, 'aria-label'>>>;
+declare const PaginationButtonPrevPage: FC<React.PropsWithChildren<Omit<IconButtonProps, 'aria-label'>>>;
+declare const PaginationButtonLastPage: FC<React.PropsWithChildren<Omit<IconButtonProps, 'aria-label'>>>;
+declare const PaginationButtonNextPage: FC<React.PropsWithChildren<Omit<IconButtonProps, 'aria-label'>>>;
+declare const PaginationInfo: ({ ...rest }: {
+    [x: string]: any;
+}) => JSX.Element;
+declare type PaginationProps = StackProps & {
+    setPage: (page: number) => void;
+    page?: number;
+    pageSize?: number;
+    totalItems?: number;
+    isLoadingPage?: boolean;
+};
+declare const Pagination: ({ setPage, page, pageSize, totalItems, isLoadingPage, ...rest }: PaginationProps) => JSX.Element;
+
+declare type CustomProps = {
+    value?: string;
+    defaultValue?: string;
+    onChange?(value?: string): void;
+    delay?: number;
+    clearLabel?: string;
+};
+declare type SearchInputProps = Overwrite<InputProps, CustomProps>;
+declare const SearchInput: _chakra_ui_react.ComponentWithAs<"input", SearchInputProps>;
+
+declare module 'react' {
+    function forwardRef<T, P = {}>(render: (props: P, ref: React.Ref<T>) => React.ReactElement | null): (props: P & React.RefAttributes<T>) => React.ReactElement | null;
+}
+declare type SelectProps<Option, IsMulti extends boolean = false, Group extends GroupBase<Option> = GroupBase<Option>> = {
+    isAsync?: boolean;
+    isCreatable?: boolean;
+    isError?: boolean;
+    size?: string;
+    formatCreateLabel?: (inputValue: string) => ReactNode;
+    loadOptions?: (input: unknown) => TODO;
+    defaultOptions?: unknown | boolean;
+    debounceDelay?: number;
+} & Props<Option, IsMulti, Group> & Omit<BoxProps, 'defaultValue'>;
+declare const Select: <Option, IsMulti extends boolean = false, Group extends GroupBase<Option> = GroupBase<Option>>(props: {
+    isAsync?: boolean | undefined;
+    isCreatable?: boolean | undefined;
+    isError?: boolean | undefined;
+    size?: string | undefined;
+    formatCreateLabel?: ((inputValue: string) => ReactNode) | undefined;
+    loadOptions?: ((input: unknown) => TODO) | undefined;
+    defaultOptions?: unknown | boolean;
+    debounceDelay?: number | undefined;
+} & Omit<Pick<react_select_dist_declarations_src_Select.Props<Option, IsMulti, Group>, "aria-label" | "form" | "autoFocus" | "name" | "value" | "className" | "id" | "aria-errormessage" | "aria-invalid" | "aria-labelledby" | "onFocus" | "onBlur" | "onChange" | "onKeyDown" | "ariaLiveMessages" | "classNamePrefix" | "delimiter" | "formatOptionLabel" | "hideSelectedOptions" | "inputValue" | "inputId" | "instanceId" | "isClearable" | "isOptionSelected" | "menuPortalTarget" | "onInputChange" | "onMenuOpen" | "onMenuClose" | "onMenuScrollToTop" | "onMenuScrollToBottom" | "theme"> & {
+    placeholder?: React.ReactNode;
+    tabIndex?: number | undefined;
+    'aria-live'?: "off" | "assertive" | "polite" | undefined;
+    isLoading?: boolean | undefined;
+    isDisabled?: boolean | undefined;
+    components?: Partial<react_select_dist_declarations_src_components.SelectComponents<Option, IsMulti, Group>> | undefined;
+    pageSize?: number | undefined;
+    backspaceRemovesValue?: boolean | undefined;
+    blurInputOnSelect?: boolean | undefined;
+    captureMenuScroll?: boolean | undefined;
+    closeMenuOnSelect?: boolean | undefined;
+    closeMenuOnScroll?: boolean | ((event: Event) => boolean) | undefined;
+    controlShouldRenderValue?: boolean | undefined;
+    escapeClearsValue?: boolean | undefined;
+    filterOption?: ((option: react_select_dist_declarations_src_filters.FilterOptionOption<Option>, inputValue: string) => boolean) | null | undefined;
+    formatGroupLabel?: ((group: Group) => React.ReactNode) | undefined;
+    getOptionLabel?: react_select.GetOptionLabel<Option> | undefined;
+    getOptionValue?: react_select.GetOptionValue<Option> | undefined;
+    isOptionDisabled?: ((option: Option, selectValue: react_select.Options<Option>) => boolean) | undefined;
+    isMulti?: IsMulti | undefined;
+    isRtl?: boolean | undefined;
+    isSearchable?: boolean | undefined;
+    loadingMessage?: ((obj: {
+        inputValue: string;
+    }) => React.ReactNode) | undefined;
+    minMenuHeight?: number | undefined;
+    maxMenuHeight?: number | undefined;
+    menuIsOpen?: boolean | undefined;
+    menuPlacement?: react_select.MenuPlacement | undefined;
+    menuPosition?: react_select.MenuPosition | undefined;
+    menuShouldBlockScroll?: boolean | undefined;
+    menuShouldScrollIntoView?: boolean | undefined;
+    noOptionsMessage?: ((obj: {
+        inputValue: string;
+    }) => React.ReactNode) | undefined;
+    openMenuOnFocus?: boolean | undefined;
+    openMenuOnClick?: boolean | undefined;
+    options?: react_select.OptionsOrGroups<Option, Group> | undefined;
+    screenReaderStatus?: ((obj: {
+        count: number;
+    }) => string) | undefined;
+    styles?: react_select.StylesConfig<Option, IsMulti, Group> | undefined;
+    tabSelectsValue?: boolean | undefined;
+} & {}, "value" | "onChange" | "inputValue" | "menuIsOpen" | "onInputChange" | "onMenuOpen" | "onMenuClose"> & Partial<Pick<react_select_dist_declarations_src_Select.Props<Option, IsMulti, Group>, "aria-label" | "form" | "autoFocus" | "name" | "value" | "className" | "id" | "aria-errormessage" | "aria-invalid" | "aria-labelledby" | "onFocus" | "onBlur" | "onChange" | "onKeyDown" | "ariaLiveMessages" | "classNamePrefix" | "delimiter" | "formatOptionLabel" | "hideSelectedOptions" | "inputValue" | "inputId" | "instanceId" | "isClearable" | "isOptionSelected" | "menuPortalTarget" | "onInputChange" | "onMenuOpen" | "onMenuClose" | "onMenuScrollToTop" | "onMenuScrollToBottom" | "theme"> & {
+    placeholder?: React.ReactNode;
+    tabIndex?: number | undefined;
+    'aria-live'?: "off" | "assertive" | "polite" | undefined;
+    isLoading?: boolean | undefined;
+    isDisabled?: boolean | undefined;
+    components?: Partial<react_select_dist_declarations_src_components.SelectComponents<Option, IsMulti, Group>> | undefined;
+    pageSize?: number | undefined;
+    backspaceRemovesValue?: boolean | undefined;
+    blurInputOnSelect?: boolean | undefined;
+    captureMenuScroll?: boolean | undefined;
+    closeMenuOnSelect?: boolean | undefined;
+    closeMenuOnScroll?: boolean | ((event: Event) => boolean) | undefined;
+    controlShouldRenderValue?: boolean | undefined;
+    escapeClearsValue?: boolean | undefined;
+    filterOption?: ((option: react_select_dist_declarations_src_filters.FilterOptionOption<Option>, inputValue: string) => boolean) | null | undefined;
+    formatGroupLabel?: ((group: Group) => React.ReactNode) | undefined;
+    getOptionLabel?: react_select.GetOptionLabel<Option> | undefined;
+    getOptionValue?: react_select.GetOptionValue<Option> | undefined;
+    isOptionDisabled?: ((option: Option, selectValue: react_select.Options<Option>) => boolean) | undefined;
+    isMulti?: IsMulti | undefined;
+    isRtl?: boolean | undefined;
+    isSearchable?: boolean | undefined;
+    loadingMessage?: ((obj: {
+        inputValue: string;
+    }) => React.ReactNode) | undefined;
+    minMenuHeight?: number | undefined;
+    maxMenuHeight?: number | undefined;
+    menuIsOpen?: boolean | undefined;
+    menuPlacement?: react_select.MenuPlacement | undefined;
+    menuPosition?: react_select.MenuPosition | undefined;
+    menuShouldBlockScroll?: boolean | undefined;
+    menuShouldScrollIntoView?: boolean | undefined;
+    noOptionsMessage?: ((obj: {
+        inputValue: string;
+    }) => React.ReactNode) | undefined;
+    openMenuOnFocus?: boolean | undefined;
+    openMenuOnClick?: boolean | undefined;
+    options?: react_select.OptionsOrGroups<Option, Group> | undefined;
+    screenReaderStatus?: ((obj: {
+        count: number;
+    }) => string) | undefined;
+    styles?: react_select.StylesConfig<Option, IsMulti, Group> | undefined;
+    tabSelectsValue?: boolean | undefined;
+} & {}> & react_select_dist_declarations_src_useStateManager.StateManagerAdditionalProps<Option> & Omit<BoxProps, "defaultValue"> & React.RefAttributes<HTMLElement>) => React.ReactElement | null;
+
+declare const theme: any;
+
+export { ActionsButton, ActionsButtonProps, DataList, DataListAccordion, DataListAccordionButton, DataListAccordionIcon, DataListAccordionPanel, DataListCell, DataListCellProps, DataListContext, DataListFooter, DataListFooterProps, DataListHeader, DataListHeaderContext, DataListHeaderProps, DataListProps, DataListRow, DataListRowProps, FormGroup, FormGroupProps, Pagination, PaginationButtonFirstPage, PaginationButtonLastPage, PaginationButtonNextPage, PaginationButtonPrevPage, PaginationContext, PaginationContextValue, PaginationInfo, PaginationProps, SearchInput, Select, SelectProps, getPaginationInfo, theme };

package/package.json

@@ -1,11 +1,38 @@
 {
   "name": "@paygreen/pgui",
-  "version": "2.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "2.1.2",
+  "description": "PGUI is the design system coming from Paygreen.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "rm -rf ./dist && rollup -c rollup.config.js",
+    "lint": "eslint src/**/*.{js,jsx,ts,tsx,json} --max-warnings=0",
+    "lint:fix": "eslint --fix 'src/**/*.{js,jsx,ts,tsx,json}'",
+    "format": "prettier --write 'src/**/*.{js,jsx,ts,tsx,css,md,json}' --config ./.prettierrc.json",
+    "link-local-lib": "npm link @chakra-ui/react react",
+    "storybook": "start-storybook -p 6006",
+    "build-storybook": "build-storybook",
+    "prepare": "husky install"
   },
+  "lint-staged": {
+    "**/*.{ts,tsx,json,mdx}": [
+      "prettier --write --config ./.prettierrc.json",
+      "eslint --fix --max-warnings=0"
+    ]
+  },
+  "keywords": [
+    "design",
+    "system",
+    "chakra-ui",
+    "component",
+    "library",
+    "theme",
+    "react"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://gitlab.com/Paygreen-paygreen/v3/pgui.git"
@@ -15,5 +42,57 @@
   "bugs": {
     "url": "https://gitlab.com/Paygreen-paygreen/v3/pgui/issues"
   },
-  "homepage": "https://gitlab.com/Paygreen-paygreen/v3/pgui#readme"
-}
+  "homepage": "https://gitlab.com/Paygreen-paygreen/v3/pgui#readme",
+  "devDependencies": {
+    "@babel/core": "^7.18.9",
+    "@chakra-ui/react": "^2.2.3",
+    "@chakra-ui/theme-tools": "^2.0.5",
+    "@emotion/react": "^11.9.3",
+    "@emotion/styled": "^11.9.3",
+    "@rollup/plugin-commonjs": "^22.0.1",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-typescript": "^8.3.3",
+    "@storybook/addon-actions": "^6.5.9",
+    "@storybook/addon-essentials": "^6.5.9",
+    "@storybook/addon-interactions": "^6.5.9",
+    "@storybook/addon-links": "^6.5.9",
+    "@storybook/builder-webpack4": "^6.5.9",
+    "@storybook/manager-webpack4": "^6.5.9",
+    "@storybook/react": "^6.5.9",
+    "@storybook/testing-library": "^0.0.13",
+    "@trivago/prettier-plugin-sort-imports": "^3.3.0",
+    "@types/react": "^18.0.15",
+    "@typescript-eslint/eslint-plugin": "^5.30.6",
+    "@typescript-eslint/parser": "^5.30.6",
+    "babel-loader": "^8.2.5",
+    "dayjs": "^1.11.4",
+    "eslint": "^8.20.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-import-resolver-typescript": "^3.2.7",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsx-a11y": "^6.6.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-storybook": "^0.6.1",
+    "framer-motion": "4.1.17",
+    "husky": "^8.0.1",
+    "lint-staged": "^13.0.3",
+    "prettier": "^2.7.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-focus-lock": "^2.9.1",
+    "react-icons": "^4.4.0",
+    "react-select": "^5.4.0",
+    "rollup": "^2.77.0",
+    "rollup-plugin-dts": "^4.2.2",
+    "rollup-plugin-node-externals": "^4.1.1",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-terser": "^7.0.2",
+    "sass": "^1.53.0",
+    "typescript": "^4.7.4"
+  }
+}