PageBanner

A reusable banner component for React applications.

Installation

npm install @pagedotapp/page-banner

Usage

import { PageBanner } from "@pagedotapp/page-banner"

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

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

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

Sizes

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

States

<PageBanner disabled>Disabled</PageBanner>

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 build the component:

npm run build