PageIconButton

A reusable iconbutton component for React applications.

Installation

npm install @pagedotapp/page-icon-button

Usage

import { PageIconButton } from "@pagedotapp/page-icon-button"

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

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

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

Sizes

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

States

<PageIconButton disabled>Disabled</PageIconButton>

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