@chayns-components/color-picker 5.0.32 → 5.0.34

package/AI_USAGE.md

@@ -0,0 +1,204 @@
+# @chayns-components/color-picker
+
+React component package providing 4 documented components for chayns applications.
+
+Documented components: `ColorPicker`, `ColorPickerPopup`, `HueSlider`, `TransparencySlider`.
+
+## Import
+
+```ts
+import { ColorPicker, ColorPickerPopup, HueSlider } from '@chayns-components/color-picker';
+```
+
+## Typical Usage
+
+```tsx
+<ColorPicker />
+```
+
+## Components
+
+- `ColorPicker`
+- `ColorPickerPopup`
+- `HueSlider`
+- `TransparencySlider`
+
+## ColorPicker
+
+`ColorPicker` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
+
+### Import
+
+```ts
+import { ColorPicker } from '@chayns-components/color-picker';
+```
+
+### Examples
+
+#### General
+
+```tsx
+<ColorPicker />
+```
+
+#### With Custom Children
+
+```tsx
+<ColorPicker />
+```
+
+#### With Preset Colors
+
+```tsx
+<ColorPicker
+    shouldShowPresetColors
+/>
+```
+
+#### With Transparency Slider
+
+```tsx
+<ColorPicker
+    shouldShowTransparencySlider
+/>
+```
+
+#### With More Options
+
+```tsx
+<ColorPicker
+    shouldShowMoreOptions
+/>
+```
+
+#### Show Plain
+
+```tsx
+<ColorPicker
+    shouldShowAsPopup={false}
+    shouldShowMoreOptions
+    shouldShowTransparencySlider
+    shouldShowPresetColors
+/>
+```
+
+### Props
+
+No prop documentation available.
+
+### Types
+
+No additional exported types documented.
+
+### Usage Notes
+
+- Import `ColorPicker` directly from `@chayns-components/color-picker` instead of internal source paths.
+- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+
+### Anti Patterns
+
+- Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+## ColorPickerPopup
+
+`ColorPickerPopup` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
+
+### Import
+
+```ts
+import { ColorPickerPopup } from '@chayns-components/color-picker';
+```
+
+### Examples
+
+#### General
+
+```tsx
+<ColorPickerPopup />
+```
+
+### Props
+
+No prop documentation available.
+
+### Types
+
+No additional exported types documented.
+
+### Usage Notes
+
+- Import `ColorPickerPopup` directly from `@chayns-components/color-picker` instead of internal source paths.
+- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+
+### Anti Patterns
+
+- Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+## HueSlider
+
+`HueSlider` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
+
+### Import
+
+```ts
+import { HueSlider } from '@chayns-components/color-picker';
+```
+
+### Examples
+
+#### General
+
+```tsx
+<HueSlider />
+```
+
+### Props
+
+No prop documentation available.
+
+### Types
+
+No additional exported types documented.
+
+### Usage Notes
+
+- Import `HueSlider` directly from `@chayns-components/color-picker` instead of internal source paths.
+- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+
+### Anti Patterns
+
+- Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+## TransparencySlider
+
+`TransparencySlider` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
+
+### Import
+
+```ts
+import { TransparencySlider } from '@chayns-components/color-picker';
+```
+
+### Examples
+
+#### General
+
+```tsx
+<TransparencySlider
+    color={'rgba(255, 0, 0, 1)'}
+/>
+```
+
+### Props
+
+No prop documentation available.
+
+### Types
+
+No additional exported types documented.
+
+### Usage Notes
+
+- Import `TransparencySlider` directly from `@chayns-components/color-picker` instead of internal source paths.
+- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
+
+### Anti Patterns
+
+- Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/color-picker",
-    "version": "5.0.32",
+    "version": "5.0.34",
     "description": "A set of beautiful React components for developing your own applications with chayns.",
     "sideEffects": false,
     "browserslist": [
@@ -33,7 +33,8 @@
         "test": "__tests__"
     },
     "files": [
-        "lib"
+        "lib",
+        "AI_USAGE.md"
     ],
     "repository": {
         "type": "git",
@@ -70,7 +71,7 @@
         "typescript": "^5.9.3"
     },
     "dependencies": {
-        "@chayns-components/core": "^5.0.32",
+        "@chayns-components/core": "^5.0.34",
         "@chayns/colors": "^2.0.2"
     },
     "peerDependencies": {
@@ -83,5 +84,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "e7d1ba2399532df23a225998585a751fee352cfe"
+    "gitHead": "7c7c2d7dacbc7c8031f3bcef885e4f63b8f49b1a"
 }