@chayns-components/textstring 5.5.24 → 5.5.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +18 -2
- package/package.json +2 -2
package/AGENTS.md
CHANGED
|
@@ -79,17 +79,33 @@ import { Textstring } from '@chayns-components/textstring';
|
|
|
79
79
|
|
|
80
80
|
### Props
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
| name | type | required | description |
|
|
83
|
+
| --- | --- | --- | --- |
|
|
84
|
+
| `children` | `ReactElement<any, string \| JSXElementConstructor<any>> \| undefined` | no | The element that the text should be displayed in. |
|
|
85
|
+
| `childrenClassName` | `string \| undefined` | no | The class name of the HTML element that the text should be displayed in. Only used if `children` is not set. |
|
|
86
|
+
| `childrenStyles` | `CSSProperties \| undefined` | no | The styles of the HTML element that the text should be displayed in. Only used if `children` is not set. |
|
|
87
|
+
| `childrenTagName` | `keyof IntrinsicElements \| undefined` | no | The tag of the HTML element that the text should be displayed in. Only used if `children` is not set. |
|
|
88
|
+
| `isTextstringHTML` | `boolean \| undefined` | no | Whether the textstring contains HTML elements and should be displayed as HTML. |
|
|
89
|
+
| `replacements` | `TextstringReplacement \| undefined` | no | Replacement values for the textstring. |
|
|
90
|
+
| `textstring` | `ITextstring` | yes | The text that should be displayed. |
|
|
83
91
|
|
|
84
92
|
### Types
|
|
85
93
|
|
|
86
|
-
|
|
94
|
+
- `ITextstring` -> `interface ITextstring {
|
|
95
|
+
fallback: string;
|
|
96
|
+
name: string;
|
|
97
|
+
}`
|
|
98
|
+
- `TextstringReplacement` -> `interface TextstringReplacement {
|
|
99
|
+
[key: string]: string;
|
|
100
|
+
}`
|
|
87
101
|
|
|
88
102
|
### Usage Notes
|
|
89
103
|
|
|
90
104
|
- Import `Textstring` directly from `@chayns-components/textstring` instead of internal source paths.
|
|
91
105
|
- Start with one of the documented Storybook examples and adapt the props incrementally for your use case.
|
|
106
|
+
- Pay special attention to required props: `textstring`.
|
|
92
107
|
|
|
93
108
|
### Anti Patterns
|
|
94
109
|
|
|
95
110
|
- Avoid imports from internal paths such as `@chayns-components/textstring/src/...`; always use the public package export.
|
|
111
|
+
- Avoid incomplete prop objects; follow the documented prop types and required fields.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@chayns-components/textstring",
|
|
3
|
-
"version": "5.5.
|
|
3
|
+
"version": "5.5.28",
|
|
4
4
|
"description": "A set of beautiful React components for developing your own applications with chayns.",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"browserslist": [
|
|
@@ -82,5 +82,5 @@
|
|
|
82
82
|
"publishConfig": {
|
|
83
83
|
"access": "public"
|
|
84
84
|
},
|
|
85
|
-
"gitHead": "
|
|
85
|
+
"gitHead": "20b5354c0ee43c56e9919589f6b3bad7cf6b14bb"
|
|
86
86
|
}
|