Skip to content

Commit

Permalink
Add site
Browse files Browse the repository at this point in the history
  • Loading branch information
petyosi committed Feb 8, 2025
1 parent f362773 commit 00d7e4f
Show file tree
Hide file tree
Showing 93 changed files with 29,571 additions and 9,287 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,7 @@ dist
build
.turbo
test-results

# generated docs
docs/virtuoso-api/*
docs/virtuoso-message-list-api/*
22 changes: 22 additions & 0 deletions apps/virtuoso.dev/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Dependencies
./node_modules

# Production
/build
docs/virtuoso-api/*
docs/virtuoso-message-list-api/*

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
4 changes: 4 additions & 0 deletions apps/virtuoso.dev/.sample.env.local
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
PADDLE_ENVIRONMENT='sandbox'
PADDLE_TOKEN=test_5
PADDLE_STANDARD_PRICE_ID=pri_01
PADDLE_PRO_PRICE_ID=pri_01
3 changes: 3 additions & 0 deletions apps/virtuoso.dev/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
1 change: 1 addition & 0 deletions apps/virtuoso.dev/docs/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
213 changes: 213 additions & 0 deletions apps/virtuoso.dev/docs/guides/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,213 @@
---
id: getting-started
title: Getting Started with React Virtuoso
sidebar_label: Getting Started
sidebar_position: 1
slug: /
---

**React Virtuoso** is a set of React components that display large data sets using **virtualized rendering**. The Virtuoso components automatically handle items with variable sizes and changes in items' sizes.

The `react-virtuoso` NPM package includes a flat list (`Virtuoso`), a grouped list with sticky headers (`GroupedVirtuoso`), a grid with a responsive layout (`VirtuosoGrid`), and a table (`TableVirtuoso`). The package is tree-shakeable, so your bundle should not be inflated by the components you don't refer to.

:::info
<h2 className="newLabel">Virtuoso Message List</h2>

The `VirtuosoMessageList` component is a newly released React component built **specifically for human and AI chatbot conversations**. [Check out the live example](/virtuoso-message-list/).
:::

## License

The `react-virtuoso` package is distributed under the MIT license. The `VirtuosoMessageList` component and the contents of the `@virtuoso.dev/message-list` package are distributed under a commercial license. See [pricing](/pricing) for more details.

## Feature Overview

The Virtuoso components automatically handle **items with variable heights**. You don't have to hard-code or manually measure item sizes. Furthermore, the components monitor any changes in the item's sizes (for example, due to content load) and re-adjust the scroll area size. The component container size itself is also monitored, so that the list reacts to browser resizing or sibling elements changing its layout.

A common use case that's covered by the components' API is the **bi-directional endless scrolling** or the **press to load** UI patterns. The components can be configured to **start from an initial location**, thus skipping the initial rendering (and the potential need of data loading) of the topmost list items. The components expose `startReached` and `endReached` callback properties, suitable for loading data on demand. After the data has been loaded, You can **append** or **prepend** additional items, while retaining the current scroll location.

The markup of the components is customizable by passing custom components as props, supporting optional **Header** and **Footer**, or swapping the **scroller element with a custom one** (usually done for the sake of integrating a third party scrollbar library). The customization API makes it easy to combine the components with your UI library of choice (e.g. MUI), or even integrate drag-and-drop through a third-party library.

To get a better impression of what's possible, examine the various examples in the documentation, and skim through the API reference.

## Installation (react-virtuoso)

React virtuoso is distributed as an NPM package.

To use the `Virtuoso`, `TableVirtuoso`, `GroupedVirtuoso`, and `VirtuosoGrid` components, install `react-virtuoso` in your React project.

```bash
npm install react-virtuoso
```

## Installation (@virtuoso.dev/message-list)

Install the `@virtuoso.dev/message-list` package to use the `VirtuosoMessageList` component.

```bash
npm install @virtuoso.dev/message-list
```

Then follow the installation section in the [Virtuoso Message List](/virtuoso-message-list) guide.

## Virtuoso

Add the Component to your application.

```jsx
import * as React from 'react'
import * as ReactDOM from 'react-dom'
import { Virtuoso } from 'react-virtuoso'

const App = () => (
<Virtuoso
style={{ height: '400px' }}
totalCount={200}
itemContent={index => <div>Item {index}</div>}
/>
)

```

This is how it looks live:

```tsx live
function App() {
return <Virtuoso
style={{ height: "400px" }}
totalCount={200}
itemContent={(index) => <div>Item {index}</div>}
/>
}
```

## VirtuosoMessageList

The Message List component is specifically built for human and/or AI chatbot conversations. Follow the instructions in the [Virtuoso Message List](/virtuoso-message-list) guide to install and use the `VirtuosoMessageList` component.

## GroupedVirtuoso

The `GroupedVirtuoso` component is similar to the "flat" `Virtuoso`, with the following differences:

* Instead of `totalCount`, the Component accepts `groupedCounts: number[]`, which specifies the amount of items in each group.
For example, passing `[20, 30]` will render two groups with 20 and 30 items each;
* In addition the `item` render prop, the Component requires an additional `group` render prop,
which renders the **group header**. The `group` callback receives the zero-based group index as a parameter;
* The `itemContent` render prop gets called with an additional second parameter, `groupIndex: number`.

```jsx live noInline
const groupCounts = []
for (let index = 0; index < 1000; index++) {
groupCounts.push(10)
}

function App() {
return (
<GroupedVirtuoso
style={{ height: "400px" }}
groupCounts={groupCounts}
groupContent={index => {
return (
<div style={{ backgroundColor: 'white' }}>
Group {index * 10} &ndash; {index * 10 + 10}
</div>
)
}}
itemContent={(index, groupIndex) => {
return (
<div>Item {groupIndex}.{index}</div>
)
}}
/>
)
}

render(<App />)
```

Check the
[grouped numbers](/grouped-numbers),
[grouped by first letter](/grouped-by-first-letter) and
[groups with load on demand](/grouped-with-load-on-demand)
examples.

## TableVirtuoso

The `TableVirtuoso` component works like the `Virtuoso` one, but with HTML tables. It supports window scrolling, sticky headers, and fixed columns.

Check the [Basic Table](/hello-table) example for a sample implementation.

## VirtuosoGrid

The `VirtuosoGrid` component displays **same sized items** in multiple columns.
The layout and item sizing is controlled CSS class properties or styled containers,
which allows you to use media queries, min-width, percentage, etc.

Check the [responsive grid columns](/grid-responsive-columns) example for a sample implementation.


## Performance

Several factors affect the component's performance.
The first and most important one is the *size of the visible area*.
Redrawing more items takes more time and reduces the frame rate.
To see if this affects you, reduce the component width or height;
Set the `style` property to something like `{{width: '200px'}}`.

Next, if the items are complex or slow to render, use [React.memo](https://reactjs.org/docs/react-api.html#reactmemo) for the `itemContent` contents.

```jsx
// Item contents are cached properly with React.memo
const InnerItem = React.memo(({ index }) => {
React.useEffect(() => {
console.log('inner mounting', index)
return () => {
console.log('inner unmounting', index)
}
}, [index])
return <div style={{ height: 30 }}>Item {index}</div>
})

// The callback is executed often - don't inline complex components in here.
const itemContent = (index) => {
console.log('providing content', index)
return <InnerItem index={index} />
}

const App = () => {
return <Virtuoso totalCount={100} itemContent={itemContent} style={{ height: 300 }} />
}

ReactDOM.render(<App />, document.getElementById('root'))
```

You can experiment with the `increaseViewportBy` property that specifies
how much more to render in addition to the viewport's visible height.
For example, if the component is `100px` tall, setting the `increaseViewportBy`
to `150` will cause the list to render **at least** `250px` of content.

Loading images and displaying complex components while scrolling can cause jank.
To fix that, you can hook to the `isScrolling` callback and replace
the problematic content in the item with a simplified one.
Check the [scroll handling example](/scroll-handling) for a possible implementation.

## Caveats

Setting **CSS margins** to the content or the item elements is the Kryptonite of Virtuoso's content measuring mechanism - the [`contentRect` measurement](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) does not include them.

If this affects you, the total scroll height will be miscalculated, and the user won't be able to scroll all the way down to the list.

To avoid that, if you are putting paragraphs and headings inside the `item`, make sure that the top/bottom elements' margins do not protrude outside of the item container.

```jsx
<Virtuoso
totalCount={100}
item={index => (
<div>
<p style={{ margin: 0 }}>Item {index}</p>
</div>
)}
/>
```

A few more common problems are present in the [troubleshooting section](/troubleshooting).
2 changes: 2 additions & 0 deletions apps/virtuoso.dev/docs/guides/grouped-virtuoso/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: Grouped Virtuoso
position: 4
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
id: grouped-by-first-letter
title: Grouped by First Letter
sidebar_label: Grouped by First Letter
slug: /grouped-by-first-letter/
sidebar_position: 2
---

Here is a more complex `GroupedVirtuoso` example displaying 200 users, grouped by the first letter of their name.
The `generateGroupedUsers` is a dummy implementation that builds grouped data. The `users` variable contains 500 user records,
The `groups` variable contains the first letter groups -> `['A', 'B', 'C']`.
The `groupCounts` specifies how many items each group has, for example `[ 20, 30, 15, 10 ]`.

```tsx live
function App() {
const { users, groups, groupCounts } = useMemo(() => {
const letters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.split('')

const users = letters.flatMap((letter) => {
return Array.from({ length: 20 }, (_, index) => ({
name: `${letter} User ${index}`,
initials: `${letter}${index}`,
description: `Description for user ${index}`,
}))
})

const groups = Array.from({ length: 10 }, (_, index) => { return letters[index] })

const groupCounts = groups.map((letter, index) => {
return users.filter((user, userIndex) => user.name.startsWith(letter)).length
})
return { users, groups, groupCounts }
}, [])

return (
<GroupedVirtuoso
groupCounts={groupCounts}
style={{ height: 400 }}
groupContent={index => {
return <div
style={{
backgroundColor: 'white',
paddingTop: '1rem',
borderBottom: '1px solid #ccc'
}}>{groups[index]}</div>
}}

itemContent={index => {
return <div>{users[index].name}</div>
}}
/>
)
}
```
30 changes: 30 additions & 0 deletions apps/virtuoso.dev/docs/guides/grouped-virtuoso/grouped-numbers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
id: grouped-numbers
title: Grouped 10,000 numbers
sidebar_label: Grouped Numbers
slug: /grouped-numbers/
sidebar_position: 1
---

The example below shows a simple grouping mode - 10,000 items in groups of 10.

```tsx live
function App() {
const groupCounts = useMemo(() => {
return Array(1000).fill(10)
}, [])

return (
<GroupedVirtuoso
style={{ height: 400 }}
groupCounts={groupCounts}
groupContent={index => {
return (
<div style={{ backgroundColor: 'var(--ifm-color-content-inverse)' }}>Group {index * 10} - {index * 10 + 10}</div>
)
}}
itemContent={(index, groupIndex) => (<div>{index} (group {groupIndex})</div>) }
/>
)
}
```
Loading

0 comments on commit 00d7e4f

Please sign in to comment.