@chayns-components/devalue-slider 5.0.33 → 5.0.34

package/AI_USAGE.md

@@ -0,0 +1,107 @@
+# @chayns-components/devalue-slider
+
+React component package providing `DevalueSlider` for chayns applications.
+
+Documented components: `DevalueSlider`.
+
+## Import
+
+```ts
+import { DevalueSlider } from '@chayns-components/devalue-slider';
+```
+
+## Typical Usage
+
+```tsx
+<DevalueSlider />
+```
+
+## DevalueSlider
+
+This is a slider component that can be devalued.
+
+For a normal devalue the user will drag the slider to the right and release it. It will show a loading cursor and call the onDevalue handler. If the onDevalue handler does not give asuccessfully response the thumb will snap back to the left. This gives feedback to the user and the person who validates the devalue.
+
+The developer should care about the some additional security measures to prevent fraud. For example this could be an offline detection. For this you can disable the Slider with the isDisabled prop. This will also cancel the current user drag.
+
+### Import
+
+```ts
+import { DevalueSlider } from '@chayns-components/devalue-slider';
+```
+
+### Examples
+
+#### General
+
+```tsx
+<DevalueSlider />
+```
+
+#### Custom Colors
+
+```tsx
+<DevalueSlider
+    color={'blue'}
+    devalueColor={'yellow'}
+/>
+```
+
+#### Devalued Slider
+
+```tsx
+<DevalueSlider
+    devalueTime={new Date(Date.now() - 5000)}
+/>
+```
+
+#### Live Update
+
+```tsx
+<DevalueSlider />
+```
+
+#### Failing Devalue
+
+```tsx
+<DevalueSlider />
+```
+
+#### Success Devalue
+
+```tsx
+<DevalueSlider />
+```
+
+#### Early Devalue Time
+
+```tsx
+<DevalueSlider
+    devalueTime={subHours(new Date(), 3)}
+/>
+```
+
+#### Custom Label
+
+```tsx
+<DevalueSlider
+    label={'ENTWERTEN'}
+/>
+```
+
+### Props
+
+No prop documentation available.
+
+### Types
+
+No additional exported types documented.
+
+### Usage Notes
+
+- Import `DevalueSlider` directly from `@chayns-components/devalue-slider` 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/devalue-slider/src/...`; always use the public package export.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chayns-components/devalue-slider",
-    "version": "5.0.33",
+    "version": "5.0.34",
     "description": "A slider to devalue something.",
     "siteEffects": false,
     "browserslist": [
@@ -33,7 +33,8 @@
         "test": "__tests__"
     },
     "files": [
-        "lib"
+        "lib",
+        "AI_USAGE.md"
     ],
     "repository": {
         "type": "git",
@@ -52,7 +53,7 @@
         "url": "https://github.com/TobitSoftware/chayns-components/issues"
     },
     "dependencies": {
-        "@chayns-components/core": "^5.0.33",
+        "@chayns-components/core": "^5.0.34",
         "@react-hook/size": "^2.1.2"
     },
     "devDependencies": {
@@ -82,5 +83,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "5e41d9af042b3c272c8c08b67a9c9bf4911902f6"
+    "gitHead": "7c7c2d7dacbc7c8031f3bcef885e4f63b8f49b1a"
 }