fixed-box

0.2.0 • Public • Published

FixedBox

npm License code style: prettier PRs Welcome

Fixed box component for React | github.com/Eazymov/fixed-box

Installation

Direct <script /> include

The library will be exposed as a global FixedBox variable

<script src="https://cdn.jsdelivr.net/npm/fixed-box@latest"></script>

or via unpkg

<script src="https://unpkg.com/fixed-box@latest"></script>

NPM

npm install fixed-box --save

Yarn

yarn add fixed-box

Props

className

FixedBox container element class name
type: string
required: none

edges

Minimal positions for the child element
type:

{
  top?: number,
  right?: number,
  bottom?: number,
  left?: number,
}

required: none

children

React node or function that returns react node and takes isFixed boolean value as argument
type: React$Node | (isFixed: boolean) => React$Node
required: none

Questions

If you have any troubles, questions or proposals you can create the issue
Good pull requests are also appreciated :)

License

MIT

Copyright (c) 2018 - present, Eduard Troshin

Package Sidebar

Install

npm i fixed-box

Weekly Downloads

2

Version

0.2.0

License

MIT

Unpacked Size

21 kB

Total Files

13

Last publish

Collaborators

  • eazymov