@pagedotapp/page-carousel

PageCarousel

A reusable carousel component for React applications.

Installation

npm install @pagedotapp/page-carousel

Usage

import { PageCarousel } from "@pagedotapp/page-carousel"

function App() {
	return (
		<PageCarousel variant="primary" size="medium">
			PageCarousel Content
		</PageCarousel>
	)
}

Props

Prop	Type	Default	Description
children	React.ReactNode	-	Component children
className	string	''	Additional CSS class name
variant	'default' | 'primary' | 'secondary'	'default'	Component variant
size	'small' | 'medium' | 'large'	'medium'	Component size
disabled	boolean	false	Disabled state

Examples

Variants

<PageCarousel variant="default">Default</PageCarousel>
<PageCarousel variant="primary">Primary</PageCarousel>
<PageCarousel variant="secondary">Secondary</PageCarousel>

Sizes

<PageCarousel size="small">Small</PageCarousel>
<PageCarousel size="medium">Medium</PageCarousel>
<PageCarousel size="large">Large</PageCarousel>

States

<PageCarousel disabled>Disabled</PageCarousel>

Styling

The component uses CSS modules for styling. You can override styles by passing a custom className or by targeting the component's CSS classes in your global styles.

Development

To run the component in development mode:

npm run storybook

To run tests:

npm run test

To lint the component:

npm run lint