@@ -35,7 +35,43 @@ function renderJson(data: any) {
3535
3636## YSON notice
3737
38- Actually the library does not support YSON-format "as is", it is impossible to parse any YSON.
39- But the library may display JSON-objects as YSON, such JSON-objects has reserver field names like ` $attributes ` , ` $value ` .
38+ The library does not support YSON-format "as is", i.e. it is impossible to use/ parse YSON data .
39+ But it provides the way to render JSON-objects as YSON, such JSON-objects has reserver field names like ` $attributes ` , ` $value ` .
4040
4141See more examples in [ storybook] ( https://preview.yandexcloud.dev/react-unipika ) .
42+
43+ ## Props
44+
45+ ### ReactUnipika Component Props
46+
47+ | Prop | Type | Default | Description |
48+ | ------------------ | --------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ |
49+ | ` value ` | ` any ` | required | The data to be rendered |
50+ | ` settings ` | ` UnipikaSettings ` | See below | Settings for Unipika formatting |
51+ | ` inline ` | ` boolean ` | ` false ` | Render in inline mode |
52+ | ` children ` | ` React.ReactNode ` | - | React nodes to render as children |
53+ | ` extraTools ` | ` React.ReactNode ` | - | Additional React nodes for tools |
54+ | ` virtualized ` | ` boolean ` | ` true ` | Enable virtualization for better performance with large data |
55+ | ` className ` | ` string ` | - | Custom CSS class name |
56+ | ` customLayout ` | ` (args: {toolbar: React.ReactNode; content: React.ReactNode}) => React.ReactNode ` | - | Function to customize the layout |
57+ | ` toolbarStickyTop ` | ` number ` | ` 0 ` | Top position in pixels for sticky toolbar |
58+
59+ ### UnipikaSettings
60+
61+ | Setting | Type | Default | Description |
62+ | ------------------- | --------- | -------- | -------------------------------------------------- |
63+ | ` asHTML ` | ` boolean ` | ` true ` | Render as HTML |
64+ | ` format ` | ` string ` | ` 'json' ` | Format type ('json', 'yson', 'raw-json') |
65+ | ` compact ` | ` boolean ` | ` false ` | Use compact rendering |
66+ | ` escapeWhitespace ` | ` boolean ` | ` true ` | Escape whitespace characters |
67+ | ` showDecoded ` | ` boolean ` | ` true ` | Show decoded values |
68+ | ` binaryAsHex ` | ` boolean ` | ` true ` | Display binary data as hexadecimal |
69+ | ` nonBreakingIndent ` | ` boolean ` | - | Use non-breaking spaces for indentation |
70+ | ` escapeYQLStrings ` | ` boolean ` | - | Escape YQL strings |
71+ | ` decodeUTF8 ` | ` boolean ` | - | Decode UTF-8 encoded strings |
72+ | ` indent ` | ` number ` | - | Indentation size |
73+ | ` break ` | ` boolean ` | - | Add line breaks |
74+ | ` maxListSize ` | ` number ` | - | Maximum number of items to display in a list |
75+ | ` maxStringSize ` | ` number ` | - | Maximum string length to display before truncating |
76+ | ` omitStructNull ` | ` boolean ` | - | Omit null values in structures |
77+ | ` treatValAsData ` | ` boolean ` | - | Treat values as data |
0 commit comments