@idui/react-sheet
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

Sheet React Component

NPM Size JavaScript Style Guide Coverage Status LICENSE

Install

npm install --save @idui/react-sheet
yarn add @idui/react-sheet

Advantages

  • can be resizable
  • uses styled-components
  • has 4 different placements (bottom, top, right, left)
  • can be controlled by children function
  • can be closed by content function

See props in Docs

Basic Example

import React from 'react'
import Sheet from '@idui/react-sheet'

function Example() {
    return <Sheet 
        content={<span>Sheet Content</span>}
    >
        <button>Open Sheet</button>
    </Sheet>
}

Resizable Sheet

import React from 'react'
import Sheet from '@idui/react-sheet'

function Example() {
    return <Sheet 
        content={<span>Sheet Content</span>}
        resizable
        onResize={(size) => console.log(`New sheet size = ${size}px`)}
    >
        <button>Open Sheet</button>
    </Sheet>
}

Controlled isOpen state

import React from 'react'
import Sheet from '@idui/react-sheet'

function Example() {
    return <Sheet 
        content={({close}) => <button onClick={close}>close</button>}
        resizable
    >
        {({open, close, toggle}) => <div>
            <button onClick={open}>open</button>
            <button onClick={close}>close</button>
            <button onClick={toggle}>toggle</button>
        </div>}
    </Sheet>
}

See more details in storybook

License

MIT © kaprisa57@gmail.com

Readme

Keywords

none

Package Sidebar

Install

npm i @idui/react-sheet

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

91.8 kB

Total Files

6

Last publish

Collaborators

  • kaprisa57