npm package: @kumodefe/rc-smart-layout
Description: A flexible and customizable layout component for React that supports resizing, collapsing, and persistent size. It allows you to manage layout sections with horizontal and vertical orientations, with the ability to adjust sizes and remember them across se
Author: kumodefe
Latest version: 1.0.8

# React Smart Layout

### [Demo](https://rc-smart-layout-demo-zmz7.vercel.app)

A flexible and customizable layout component for React that supports resizing, collapsing, and persistent size. It allows you to manage layout sections with horizontal and vertical orientations, with the ability to adjust sizes and remember them across sessions.

## Features

- **Resizable Sections**: Resize layout sections by dragging the edges.
- **Collapsible Sections**: Toggle sections between expanded and collapsed states.
- **Persistent Layout**: Store and persist section sizes across sessions using `localStorage`.
- **Responsive Layout**: Automatically adapts to different screen sizes with responsive configurations.
- **Vertical and Horizontal Layouts**: Supports both vertical and horizontal layouts.
- **Minimum Size Constraint**: Ensures sections don't shrink below a specified size.
- **Animated Transitions**: Smooth transitions when resizing or collapsing sections.

## Installation

To install the package, run the following command in your project directory:

Add tailwind config tailwind.config.js

---
If you use tailwindcss >=v4.0 use this in init css file in project:
```css
@config "path_to_your_config_tailwindcss_file"
/* example: @config "../tailwind.config.js" #for vite react */
```
---

Add needed packages to your `tailwind.config.js` file:

```ts
{
	content: ["./node_modules/rc-smart-layout/**/*.{js,ts,jsx,tsx}"],
	theme: {
		// ...
	},
	variants: {
		// ...
	},
	plugins: [],
};

```

Add needed packages with npm or yarn:

```bash
npm install lucide-react clsx
# or
yarn add lucide-react clsx

```

Install with npm or yarn:

```bash
npm install @kumodefe/rc-smart-layout
# or
yarn add @kumodefe/rc-smart-layout
```

## Usage

### Basic Layout

```tsx
import {SmartLayout} from "@kumodefe/rc-smart-layout";

const App = () => (
	<SmartLayout direction="vertical" responsive>
		<SmartLayout.Header resizable>Header Content</SmartLayout.Header>
		<SmartLayout.Body>Main Content</SmartLayout.Body>
		<SmartLayout.Footer>Footer Content</SmartLayout.Footer>
	</SmartLayout>
);
```

### Resizable and Collapsible Sections

```tsx
import {SmartLayout} from "@kumodefe/rc-smart-layout";

const App = () => (
	<SmartLayout direction="horizontal">
		<SmartLayout.Header resizable>Header Content</SmartLayout.Header>
		<SmartLayout.Body resizable collapsible>
			Main Content
		</SmartLayout.Body>
		<SmartLayout.Footer>Footer Content</SmartLayout.Footer>
	</SmartLayout>
);
```
---

### With Persistent Size and Minimum Size

```tsx
import {SmartLayout} from "@kumodefe/rc-smart-layout";

const App = () => (
	<SmartLayout direction="vertical">
		<SmartLayout.Header resizable initialSize={200} persistKey="header-size">
			Header Content
		</SmartLayout.Header>
		<SmartLayout.Body resizable minSize="100px" initialSize={400}>
			Main Content
		</SmartLayout.Body>
		<SmartLayout.Footer>Footer Content</SmartLayout.Footer>
	</SmartLayout>
);
```

---

## Customization

```tsx
import {SmartLayout} from "@kumodefe/rc-smart-layout";

const SmartLayoutExample = () => {
	return (
		<div className="w-full h-screen">
			<SmartLayout direction="vertical" preset="card" responsive className="border bg-white shadow">
				<SmartLayout.Header
					resizable
					collapsible
					showToggle
					persistKey="layout-header"
					initialSize={100}
					minSize="60px"
					maxSize="200px"
					animated
				>
					<div className="h-full p-4 bg-blue-100">Header (resizable + collapsible)</div>
				</SmartLayout.Header>

				<SmartLayout.Body>
					<div className="h-full p-4 bg-gray-100 overflow-auto">
						<p className="mb-2">Body (scrollable, grows automatically)</p>
						{[...Array(20)].map((_, i) => (
							<p key={i}>Lorem ipsum #{i + 1}</p>
						))}
					</div>
				</SmartLayout.Body>

				<SmartLayout.Footer minSize="50px" maxSize="120px">
					<div className="h-full p-4 bg-green-100">Footer (static)</div>
				</SmartLayout.Footer>
			</SmartLayout>
		</div>
	);
};

export default SmartLayoutExample;
```

## Props

### SmartLayout

| Prop         | Type                                        | Description                                                 |
| ------------ | ------------------------------------------- | ----------------------------------------------------------- |
| `direction`  | `"vertical"` or `"horizontal"`              | The layout orientation (default: `"vertical"`)              |
| `responsive` | `boolean`                                   | Enables responsive layout (default: `false`)                |
| `preset`     | `"modal"`, `"card"`, `"split"`, `"sidebar"` | Optional preset styles for the layout.                      |
| `className`  | `string`                                    | Custom class names for styling                              |
| `as`         | `string`                                    | The HTML element to render the layout as (default: `"div"`) |

### Section (`SmartLayout.Header`, `SmartLayout.Body`, `SmartLayout.Footer`)

| Prop               | Type                           | Description                                             |
| ------------------ | ------------------------------ | ------------------------------------------------------- |
| `children`         | `ReactNode`                    | Content of the section                                  |
| `resizable`        | `boolean`                      | Whether the section is resizable (default: `false`)     |
| `collapsible`      | `boolean`                      | Whether the section can be collapsed (default: `false`) |
| `collapsed`        | `boolean`                      | Initial collapsed state (default: `false`)              |
| `onToggleCollapse` | `(collapsed: boolean) => void` | Callback when collapsing or expanding the section       |
| `minSize`          | `string`                       | Minimum size of the section (e.g., `"100px"`)           |
| `maxSize`          | `string`                       | Maximum size of the section (e.g., `"500px"`)           |
| `initialSize`      | `number`                       | Initial size in pixels                                  |
| `persistKey`       | `string`                       | The key to store the size in `localStorage`             |
| `animated`         | `boolean`                      | Whether to apply smooth transitions (default: `false`)  |

## License

This project is licensed under the MIT License.

## Keywords
layout, smart layout, dynamic layout, responsive, grid, flexbox, ui layout, react layout, nextjs layout, tailwind, ui, component, react component, layout system, custom layout, split layout, responsive layout, collapsible layout, react layout component, layout model, component layout, react, resizable, collapsible