@chayns-components/color-picker 5.5.26 → 5.5.28

package/AGENTS.md

@@ -84,7 +84,24 @@ import { ColorPicker } from '@chayns-components/color-picker';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `alignment` | `PopupAlignment \| undefined` | no | The alignment of the popup |
+| `children` | `ReactNode` | no | The element that should be rendered to trigger the ColorPicker popup on click. |
+| `onPresetColorAdd` | `((presetColor: IPresetColor) => void) \| undefined` | no | Function to be executed when a preset color is added. |
+| `onPresetColorRemove` | `((presetColorId: string) => void) \| undefined` | no | Function to be executed when a preset color is removed. |
+| `onSelect` | `((color: string) => void) \| undefined` | no | Function to be executed when a color is selected. |
+| `presetColors` | `IPresetColor[] \| undefined` | no | Colors the user can select from. |
+| `selectedColor` | `string \| undefined` | no | The color that should be preselected. |
+| `shouldHideColorArea` | `boolean \| undefined` | no | Whether the color area should be displayed. |
+| `shouldHideDefaultPresetColors` | `boolean \| undefined` | no | Whether the default preset colors should be hidden. |
+| `shouldShowAsPopup` | `boolean \| undefined` | no | Whether the ColorPicker should be displayed inside a popup. |
+| `shouldShowMoreOptions` | `boolean \| undefined` | no | Whether the more options accordion should be displayed. |
+| `shouldShowPresetColors` | `boolean \| undefined` | no | Whether the preset colors should be displayed. |
+| `shouldShowPreviewColorString` | `boolean \| undefined` | no | Whether the preview color should be displayed as text. |
+| `shouldShowRoundPreviewColor` | `boolean \| undefined` | no | Whether the preview color should be displayed round. |
+| `shouldShowTransparencySlider` | `boolean \| undefined` | no | Whether the transparency slider should be displayed. |
+| `shouldUseSiteColors` | `boolean \| undefined` | no | Whether presetColors should be got and uploaded to the site storage. |
 
 ### Types
 
@@ -98,6 +115,7 @@ No additional exported types documented.
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.
 ## ColorPickerPopup
 
 `ColorPickerPopup` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
@@ -118,7 +136,17 @@ import { ColorPickerPopup } from '@chayns-components/color-picker';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `onPresetColorAdd` | `((presetColor: IPresetColor) => void) \| undefined` | no | No description available. |
+| `onPresetColorRemove` | `((presetColorId: string) => void) \| undefined` | no | No description available. |
+| `presetColors` | `IPresetColor[] \| undefined` | no | No description available. |
+| `shouldHideColorArea` | `boolean` | yes | No description available. |
+| `shouldHideDefaultPresetColors` | `boolean` | yes | No description available. |
+| `shouldShowMoreOptions` | `boolean` | yes | No description available. |
+| `shouldShowPresetColors` | `boolean` | yes | No description available. |
+| `shouldShowTransparencySlider` | `boolean` | yes | No description available. |
+| `shouldUseSiteColors` | `boolean` | yes | No description available. |
 
 ### Types
 
@@ -128,10 +156,12 @@ No additional exported types documented.
 
 - 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.
+- Pay special attention to required props: `shouldHideColorArea`, `shouldHideDefaultPresetColors`, `shouldShowMoreOptions`, `shouldShowPresetColors`, `shouldShowTransparencySlider`, `shouldUseSiteColors`.
 
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.
 ## HueSlider
 
 `HueSlider` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
@@ -152,7 +182,13 @@ import { HueSlider } from '@chayns-components/color-picker';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `color` | `Color \| undefined` | no | The color that should be selected. |
+| `onChange` | `((rgb: Color \| undefined, hsl: Color \| undefined) => void) \| undefined` | no | Function that will be executed when the color is changed. |
+| `onEnd` | `((rgb: Color \| undefined, hsl: Color \| undefined) => void) \| undefined` | no | Function that will be executed when the color is ending to change. |
+| `onStart` | `((rgb: Color \| undefined, hsl: Color \| undefined) => void) \| undefined` | no | Function that will be executed when the color is starting to change. |
+| `opacity` | `number \| undefined` | no | The opacity of the Color. Is used if the color has no opacity value. |
 
 ### Types
 
@@ -166,6 +202,7 @@ No additional exported types documented.
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.
 ## TransparencySlider
 
 `TransparencySlider` is exported by `@chayns-components/color-picker` and should be imported from the public package entry point.
@@ -188,7 +225,12 @@ import { TransparencySlider } from '@chayns-components/color-picker';
 
 ### Props
 
-No prop documentation available.
+| name | type | required | description |
+| --- | --- | --- | --- |
+| `color` | `string \| undefined` | no | The color that should be selected. |
+| `onChange` | `((color: string) => void) \| undefined` | no | Function that will be executed when the opacity is changed. |
+| `onEnd` | `((color: string) => void) \| undefined` | no | Function that will be executed when the opacity is ending to change. |
+| `onStart` | `((color: string) => void) \| undefined` | no | Function that will be executed when the opacity is starting to change. |
 
 ### Types
 
@@ -202,3 +244,4 @@ No additional exported types documented.
 ### Anti Patterns
 
 - Avoid imports from internal paths such as `@chayns-components/color-picker/src/...`; always use the public package export.
+- Avoid incomplete prop objects; follow the documented prop types and required fields.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/color-picker",
-    "version": "5.5.26",
+    "version": "5.5.28",
     "description": "A set of beautiful React components for developing your own applications with chayns.",
     "sideEffects": false,
     "browserslist": [
@@ -69,8 +69,8 @@
         "typescript": "^5.9.3"
     },
     "dependencies": {
-        "@chayns-components/core": "^5.5.26",
-        "@chayns-components/textstring": "^5.5.24",
+        "@chayns-components/core": "^5.5.28",
+        "@chayns-components/textstring": "^5.5.28",
         "@chayns/colors": "^2.0.2",
         "react-compiler-runtime": "^1.0.0"
     },
@@ -84,5 +84,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "92d9195193d59f3180f001b3545b34167476d6a7"
+    "gitHead": "20b5354c0ee43c56e9919589f6b3bad7cf6b14bb"
 }