react-spaces

React components that allow you to divide a page or container into nestable anchored, scrollable and resizable spaces.

Github星跟踪图

React Spaces

NPM Azure Pipelines

React Spaces allow you to divide a page or container HTML element into spaces. These spaces know how to behave in relation to each other and can also be divided into further nested spaces.

View full documentation here.

Top level spaces

Used at the top level of all other spaces.

<ViewPort />

This space will take over the full viewport of the browser window. Resizing the browser window will automatically adjust the size of this space and all the nested spaces.

<Fixed />

This space can be given a height and optionally a width (by default it will size to 100% of it's container). All nested spaces will be contained within this fixed size space.

Anchored spaces

These can be used within the top-level spaces <ViewPort /> and <Fixed /> or nested within other spaces.

<Left /> and <Right />

A space anchored to the left or right of the parent container/space. A size can be specified in pixels or as a percentage to determine its width.

<Top /> and <Bottom />

A space anchored to the top or bottom of the parent container/space. A size can be specified in pixels or as a percentage to determine its height.

There are resizable versions of these components called <LeftResizable />, <RightResizable />, <TopResizable /> and <BottomResizable /> which allow the spaces to be resized from the outer edge by dragging with the mouse.

Other

<Fill />

A space which consumes any available area left in the parent container/space taking into account any anchored spaces on every side.

<Layer />

Layers allow you to create layers within a parent space, for example:

<ViewPort>
  
  <Layer zIndex={0}>
  	<LeftResizable size="20%" /> // floating sidebar
  </Layer>
  
  <Layer zIndex={1}>
  	<Fill />
  </Layer>

</ViewPort>

<Centered />

Centres the content of a space horizontally and vertically.

<CenteredVertically />

Centres the content of a space vertically.

Getting started

To get started with React Spaces you need:

npm install react-spaces --save
import * as Spaces from 'react-spaces';

View full documentation here.

Donation

If you find this library useful, consider making a small donation to fund a cup of coffee:



主要指标

概览
名称与所有者aeagle/react-spaces
主编程语言TypeScript
编程语言CSS (语言数: 6)
平台
许可证MIT License
所有者活动
创建于2019-07-21 03:58:06
推送于2025-03-13 17:07:36
最后一次提交2025-03-13 17:00:39
发布数76
最新版本名称v0.5.1 (发布于 2025-03-13 17:07:36)
第一版名称v0.1.0 (发布于 )
用户参与
星数1.3k
关注者数12
派生数26
提交数588
已启用问题?
问题数69
打开的问题数10
拉请求数82
打开的拉请求数12
关闭的拉请求数18
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?