@peculiar/react-components 1.3.0 → 1.3.2

package/dist/types/Popper/popper.d.ts

@@ -18,6 +18,7 @@ interface IBaseProps {
     anchorEl?: Element;
     /**
      * Popper placement.
+     * @default 'bottom'
      */
     placement?: PopperReactProps<unknown>['placement'];
     /**
@@ -26,6 +27,7 @@ interface IBaseProps {
     disablePortal?: boolean;
     /**
      * Make your popper the same width as the reference.
+     * @default false
      */
     allowUseSameWidth?: boolean;
     /**

package/dist/types/Radio/radio.d.ts

@@ -13,6 +13,7 @@ interface IRadioOwnProps {
     defaultChecked?: boolean;
     /**
      * The color of the component.
+     * @default 'primary'
      */
     color?: ('primary' | 'secondary');
     /**

package/dist/types/Select/select.d.ts

@@ -15,6 +15,7 @@ export type TSelectOwnProps<T, Multiple extends boolean | undefined = undefined>
     className?: string;
     /**
      * The size of the root component.
+     * @default 'medium'
      */
     size?: ('small' | 'medium' | 'large');
     /**
@@ -27,28 +28,34 @@ export type TSelectOwnProps<T, Multiple extends boolean | undefined = undefined>
     label?: string;
     /**
      * Text to display when there are no options.
+     * @default 'No options'
      */
     noOptionsText?: React.ReactNode;
     /**
      * If `true`, the component is in a loading state.
      * This shows the `loadingText` in place of suggestions (only if there are no
      * suggestions to show, e.g. `options` are empty).
+     * @default false
      */
     loading?: boolean;
     /**
      * Text to display when in a loading state.
+     * @default 'Loading...'
      */
     loadingText?: React.ReactNode;
     /**
      * The maximum number of tags that will be visible when not focused.
+     * @default 2
      */
     limitTags?: number;
     /**
      * If `true`, the popup search input will be hidden.
+     * @default false
      */
     disableSearch?: boolean;
     /**
      * If `true`, the autocomplete will be disabled.
+     * @default false
      */
     disabled?: boolean;
     /**
@@ -57,20 +64,26 @@ export type TSelectOwnProps<T, Multiple extends boolean | undefined = undefined>
     name?: string;
     /**
      * If `true`, the `input` element is required.
+     * @default false
      */
     required?: boolean;
     /**
      * Text to display when in the create button element.
+     * @default 'Create "{{value}}"'
      */
     createOptionText?: string;
     /**
      * If `true`, the create button element will be shown.
+     * @default false
      */
     allowCreateOption?: boolean;
     /**
      * If `true`, the `input` will indicate an error.
      */
     error?: boolean;
+    /**
+     * The content of the error message.
+     */
     errorText?: string;
     /**
      * Render the root element.
@@ -82,6 +95,7 @@ export type TSelectOwnProps<T, Multiple extends boolean | undefined = undefined>
     renderOption?: (props: ReturnType<IUseAutocompleteReturnType<T, Multiple>['getOptionProps']>, option: T) => React.ReactNode;
     /**
      * The label to display when the tags are truncated (`limitTags`).
+     * @default (more) => `${more} more`
      */
     getLimitTagsText?: (more: number) => string;
     /**
@@ -94,15 +108,5 @@ export type TSelectOwnProps<T, Multiple extends boolean | undefined = undefined>
  */
 export declare const Select: {
     <T, Multiple extends boolean = false>(props: TSelectOwnProps<T, Multiple>): JSX.Element;
-    defaultProps: {
-        disableSearch: boolean;
-        noOptionsText: string;
-        loading: boolean;
-        loadingText: string;
-        limitTags: number;
-        required: boolean;
-        allowCreateOption: boolean;
-        createOptionText: string;
-        size: string;
-    };
+    displayName: string;
 };

package/dist/types/Skeleton/skeleton.d.ts

@@ -19,8 +19,12 @@ export interface ISkeletonOwnProps {
     width?: number | string;
     /**
      * The type of content that will be rendered.
+     * @default 'text'
      */
     variant?: ('text' | 'rect' | 'circle');
+    /**
+     * @default 'gray-4'
+     */
     background?: TColorType;
 }
 export interface ISkeletonTypeMap<P = object, D extends React.ElementType = 'span'> {

package/dist/types/Slide/slide.d.ts

@@ -8,6 +8,7 @@ interface IBaseProps {
     in?: boolean;
     /**
      * The duration for the transition, in milliseconds.
+     * @default 225
      */
     timeout?: number;
     /**
@@ -16,10 +17,12 @@ interface IBaseProps {
     children: React.ReactElement;
     /**
      * Direction the child node will enter from.
+     * @default 'right'
      */
     direction?: ('right' | 'left' | 'up' | 'down');
     /**
      * Perform the enter transition when it first mounts if `in` is also `true`.
+     * @default true
      */
     appear?: boolean;
 }

package/dist/types/Slider/slider.d.ts

@@ -14,14 +14,17 @@ interface ISliderOwnProps {
     value?: number;
     /**
      * If `true`, the slider will be disabled.
+     * @default false
      */
     disabled?: boolean;
     /**
      * The maximum allowed value of the slider. Should not be equal to min.
+     * @default 100
      */
     max?: number;
     /**
      * The minimum allowed value of the slider. Should not be equal to max.
+     * @default 0
      */
     min?: number;
     /**
@@ -30,6 +33,7 @@ interface ISliderOwnProps {
     name?: string;
     /**
      * The granularity with which the slider can step through values
+     * @default 1
      */
     step?: number;
     /**

package/dist/types/Switch/switch.d.ts

@@ -13,6 +13,7 @@ interface ISwitchOwnProps {
     defaultChecked?: boolean;
     /**
      * The color of the component.
+     * @default 'primary'
      */
     color?: ('primary' | 'secondary');
     /**

package/dist/types/Tabs/tab.d.ts

@@ -14,10 +14,12 @@ export interface ITabOwnProps {
     id: string;
     /**
      * If `true`, the tab will be disabled.
+     * @default false
      */
     disabled?: boolean;
     /**
      * The color of the component.
+     * @default 'black'
      */
     color?: ('black' | 'white');
     /**

package/dist/types/TextField/text_field.d.ts

@@ -5,10 +5,12 @@ import * as React from 'react';
 interface ITextFieldOwnProps {
     /**
      * If `true`, the component is disabled.
+     * @default false
      */
     disabled?: boolean;
     /**
      * The size of the input.
+     * @default 'medium'
      */
     size?: ('small' | 'medium' | 'large');
     /**

package/dist/types/TextareaField/textarea_field.d.ts

@@ -5,10 +5,12 @@ import * as React from 'react';
 interface ITextareaFieldOwnProps {
     /**
      * If `true`, the component is disabled.
+     * @default false
      */
     disabled?: boolean;
     /**
      * The size of the input.
+     * @default 'medium'
      */
     size?: ('small' | 'medium' | 'large');
     /**

package/dist/types/Toast/toast.d.ts

@@ -18,6 +18,7 @@ interface IToastOwnProps {
     onClose: (id: string) => void;
     /**
      * The delay before the toast hides (in milliseconds). If set to `null`, toast will never dismiss.
+     * @default 4000
      */
     duration?: number | null;
     /**

package/dist/types/Toast/toast_provider.d.ts

@@ -7,6 +7,7 @@ interface IBaseProps {
     children: React.ReactNode;
     /**
      * Maximum snackbars that can be stacked on bottom of one another.
+     * @default 1
      */
     maxToasts?: number;
     /**

package/dist/types/Tooltip/tooltip.d.ts

@@ -18,6 +18,7 @@ export interface ITooltipOwnProps {
     title: React.ReactNode;
     /**
      * Tooltip placement.
+     * @default 'bottom'
      */
     placement?: Placement;
     /**
@@ -26,14 +27,17 @@ export interface ITooltipOwnProps {
     className?: string;
     /**
      * Do not respond to focus events.
+     * @default false
      */
     disableFocusListener?: boolean;
     /**
      * Do not respond to hover events.
+     * @default false
      */
     disableHoverListener?: boolean;
     /**
      * Do not respond to long press touch events.
+     * @default false
      */
     disableTouchListener?: boolean;
     /**
@@ -42,31 +46,38 @@ export interface ITooltipOwnProps {
     interactive?: boolean;
     /**
      * The size of the tooltip.
+     * @default 'small'
      */
     size?: ('small' | 'large');
     /**
      * The color of the tooltip.
+     * @default 'white'
      */
     color?: ('black' | 'white');
     /**
      * Disable the portal behavior. The children stay within it's parent DOM hierarchy.
+     * @default true
      */
     disablePortal?: boolean;
     /**
      * Add delay in showing the tooltip.
+     * @default 100
      */
     enterDelay?: number;
     /**
      * Add delay in hiding the tooltip.
+     * @default 0
      */
     leaveDelay?: number;
     /**
      * If `true`, adds an arrow to the tooltip.
+     * @default false
      */
     arrow?: boolean;
     /**
      * This can be useful if you need to apply some margin between them
      * or if you need to fine tune the position according to some custom logic.
+     * @default 15
      */
     offset?: number;
 }

package/dist/types/Typography/typography.d.ts

@@ -11,10 +11,12 @@ export interface ITypographyOwnProps {
     children?: React.ReactNode;
     /**
      * The variant to use.
+     * @default 'b1'
      */
     variant?: TTypographyType;
     /**
      * The color of the component.
+     * @default 'black'
      */
     color?: TColorType | 'inherit';
     /**

package/dist/types/styles/theme_provider.d.ts

@@ -4,9 +4,23 @@ import type { IThemeOptionsType } from './types';
  * Types.
  */
 interface IThemeProviderProps {
+    /**
+     * The content of the component.
+     */
     children: React.ReactElement;
+    /**
+     * The theme object.
+     */
     theme?: IThemeOptionsType;
+    /**
+     * The theme mode.
+     * @default 'light'
+     */
     mode?: ('light' | 'dark');
+    /**
+     * The CSS variables root selector.
+     * @default 'html, ::backdrop'
+     */
     cssVarsRoot?: string;
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@peculiar/react-components",
   "private": false,
-  "version": "1.3.0",
+  "version": "1.3.2",
   "author": "PeculiarVentures Team",
   "description": "A simple and customizable component library to build faster, beautiful, and more accessible React applications.",
   "keywords": [
@@ -48,7 +48,7 @@
   "dependencies": {
     "@emotion/react": "^11.11.1",
     "@emotion/styled": "^11.11.0",
-    "@peculiar/color": "^0.1.7",
+    "@peculiar/color": "^0.1.8",
     "@popperjs/core": "^2.11.7",
     "@types/flat": "^5.0.2",
     "@types/react-transition-group": "^4.4.5",
@@ -82,5 +82,5 @@
     "node": ">=18.x"
   },
   "license": "MIT",
-  "gitHead": "e34f4ade594e6e5eff0ec614bbca4a30cfba9e4f"
+  "gitHead": "f88afba5620d4adcc157b606b276db9056a5c1dc"
 }