react-resizable-panels

To start the development server for this Next.js project, use one of the following commands in your terminal. Once running, you can view the application at http://localhost:3000.

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Install the library using npm to add resizable panel components to your React project.

npm install react-resizable-panels

To add React-specific linting, install eslint-plugin-react-x and eslint-plugin-react-dom. You can then include these plugins in your eslint.config.js and spread their recommended rules into the rules object.

// eslint.config.js
import reactX from 'eslint-plugin-react-x'
import reactDom from 'eslint-plugin-react-dom'

export default tseslint.config({
  plugins: {
    // Add the react-x and react-dom plugins
    'react-x': reactX,
    'react-dom': reactDom,
  },
  rules: {
    // other rules...
    // Enable its recommended typescript rules
    ...reactX.configs['recommended-typescript'].rules,
    ...reactDom.configs.recommended.rules,
  },
})

For production applications, it is recommended to upgrade your ESLint configuration to use type-aware lint rules. This requires updating the extends array to use recommendedTypeChecked, strictTypeChecked, or stylisticTypeChecked and configuring parserOptions to point to your tsconfig files.

export default tseslint.config({
  extends: [
    // Remove ...tseslint.configs.recommended and replace with this
    ...tseslint.configs.recommendedTypeChecked,
    // Alternatively, use this for stricter rules
    ...tseslint.configs.strictTypeChecked,
    // Optionally, add this for stylistic rules
    ...tseslint.configs.stylisticTypeChecked,
  ],
  languageOptions: {
    // other options...
    parserOptions: {
      project: ['./tsconfig.node.json', './tsconfig.app.json'],
      tsconfigRootDir: import.meta.dirname,
    },
  },
})

The Separator component is the draggable handle between Panel components. While not strictly required, it is recommended for improved keyboard accessibility.

Key Features:

• Styling: Use the data-separator attribute to apply custom hover and active styles.
• Accessibility: Automatically renders required WAI-ARIA properties.
• Double-click behavior: By default, double-clicking a separator resets the adjacent panel to its default size. Set disableDoubleClick to true to prevent this.

Note: Separator elements must be direct DOM children of their parent Group.

The Group component wraps a set of resizable Panel components. It manages the layout and allows resizing either horizontally or vertically.

Key Features:

• Orientation: Set via the orientation prop ("horizontal" or "vertical"; defaults to "horizontal").
• Layout Persistence: Use defaultLayout to allow layouts to be remembered between page reloads.
• Imperative API: Use the groupRef to access getLayout() and setLayout(layout).
• Layout Callbacks:
  • onLayoutChange: Called continuously during a resize (e.g., while a pointer is moving).
  • onLayoutChanged: Called after a resize is complete. Recommended for saving layouts to storage. The second argument includes isUserInteraction to distinguish between user input and programmatic changes.

Note: Panel and Separator components must be direct DOM children of the Group.

Vike provides a built-in router that supports three different routing strategies:

1. Filesystem Routing: The URL of a page is determined by the location of its +Page.tsx file in the filesystem.
2. Route Strings: Explicitly defining routes using strings.
3. Route Functions: Using functions to determine routes.

Vike manages Server-Side Rendering (SSR) and HTML Streaming with the following defaults:

• SSR: Enabled by default. It can be disabled globally or for specific pages.
• HTML Streaming: Can be enabled or disabled globally or for specific pages.

The Separator component accepts the following optional props: