Skip to content

chore: update readme #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Raubzeug merged 1 commit into from
Dec 3, 2025
Merged

chore: update readme #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 48 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ The library uses [`@gravity-ui/unipika`](https://github.com/gravity-ui/unipika)
### Features

- virtualization
- two scroll modes: window scroll and container scroll
- collaps/expand objects/arrays
- search substring of key/value
- search substring of key/value (case-sensitive and case-insensitive)
- render one literal per line
- long strings are truncated by ellipsis
- full value might be seen in dialog
Expand All @@ -22,17 +23,44 @@ Depending on your package manager you may need to install `peerDependencies` man

## Usage

The library provides two entry points depending on your scrolling needs:

### Window Scroll (default)

Use this when you want the component to scroll with the browser window:

```ts
import '@gravity-ui/uikit/styles/styles.scss';
import '@gravity-ui/unipika/styles/unipika.scss';

import {ReactUnipika} from '@gravity-ui/react-unipika';
import {ReactUnipika} from '@gravity-ui/react-unipika/window-scroll';

function renderJson(data: any) {
return <ReactUnipika value={data} />;
}
```

### Container Scroll

Use this when you want the component to scroll within a specific container. You must provide a ref to the scroll container:

```ts
import '@gravity-ui/uikit/styles/styles.scss';
import '@gravity-ui/unipika/styles/unipika.scss';

import {ReactUnipika} from '@gravity-ui/react-unipika/container-scroll';

function renderJson(data: any) {
const scrollContainerRef = React.useRef<HTMLDivElement>(null);

return (
<div ref={scrollContainerRef} style={{height: '500px', overflow: 'auto'}}>
<ReactUnipika value={data} scrollContainerRef={scrollContainerRef} />
</div>
);
}
```

## YSON notice

The library does not support YSON-format "as is", i.e. it is impossible to use/parse YSON data.
Expand All @@ -44,17 +72,24 @@ See more examples in [storybook](https://preview.yandexcloud.dev/react-unipika).

### ReactUnipika Component Props

| Prop | Type | Default | Description |
| ------------------ | --------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ |
| `value` | `any` | required | The data to be rendered |
| `settings` | `UnipikaSettings` | See below | Settings for Unipika formatting |
| `inline` | `boolean` | `false` | Render in inline mode |
| `children` | `React.ReactNode` | - | React nodes to render as children |
| `extraTools` | `React.ReactNode` | - | Additional React nodes for tools |
| `virtualized` | `boolean` | `true` | Enable virtualization for better performance with large data |
| `className` | `string` | - | Custom CSS class name |
| `customLayout` | `(args: {toolbar: React.ReactNode; content: React.ReactNode}) => React.ReactNode` | - | Function to customize the layout |
| `toolbarStickyTop` | `number` | `0` | Top position in pixels for sticky toolbar |
| Prop | Type | Default | Description |
| ----------------------- | --------------------------------------------------------------------------------- | --------- | --------------------------------------------------------------------------------- |
| `value` | `any` | required | The data to be rendered |
| `settings` | `UnipikaSettings` | See below | Settings for Unipika formatting |
| `inline` | `boolean` | `false` | Render in inline mode |
| `children` | `React.ReactNode` | - | React nodes to render as children |
| `extraTools` | `React.ReactNode` | - | Additional React nodes for tools |
| `virtualized` | `boolean` | `true` | Enable virtualization for better performance with large data |
| `className` | `string` | - | Custom CSS class name |
| `customLayout` | `(args: {toolbar: React.ReactNode; content: React.ReactNode}) => React.ReactNode` | - | Function to customize the layout |
| `toolbarStickyTop` | `number` | `0` | Top position in pixels for sticky toolbar |
| `renderToolbar` | `(props: ToolbarProps) => React.ReactNode` | - | Custom toolbar renderer function |
| `collapseIconType` | `CollapseIconType` | - | Type of collapse/expand icon to use |
| `showContainerSize` | `boolean` | - | Show the size of containers (objects/arrays) |
| `initiallyCollapsed` | `boolean` | - | Whether to render the tree initially collapsed |
| `caseInsensitiveSearch` | `boolean` | - | Enable case-insensitive search |
| `renderError` | `(error: unknown) => React.ReactNode` | - | Custom error renderer function |
| `scrollContainerRef` | `React.RefObject<Element \| null>` | - | **Required for container-scroll only**. Reference to the scroll container element |

### UnipikaSettings

Expand Down
Loading