Skip to content

Commit abff535

Browse files
committed
Updated build badge
1 parent 5003024 commit abff535

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# React Spaces
22

3-
![NPM](https://img.shields.io/npm/v/react-spaces.svg) ![Azure Pipelines](https://allan-eagle.visualstudio.com/All%20projects/_apis/build/status/React-Spaces%20publish)
3+
![NPM](https://img.shields.io/npm/v/react-spaces.svg) ![Azure Pipelines](https://allan-eagle.visualstudio.com/All%20projects/_apis/build/status/aeagle.react-spaces?branchName=master)
44

55
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.
66

@@ -16,27 +16,27 @@ Used at the top level of all other spaces.
1616

1717
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.
1818

19-
**\<Fixed /\>**
19+
**\<Fixed /\>**
2020

2121
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.
2222

2323
### Anchored spaces
2424

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

27-
**\<Left /\>** and **\<Right /\>**
27+
**\<Left /\>** and **\<Right /\>**
2828

2929
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.
3030

31-
**\<Top /\>** and **\<Bottom /\>**
31+
**\<Top /\>** and **\<Bottom /\>**
3232

3333
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.
3434

3535
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.
3636

3737
### Other
3838

39-
**\<Fill /\>**
39+
**\<Fill /\>**
4040

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

@@ -46,19 +46,15 @@ Layers allow you to create layers within a parent space, for example:
4646

4747
```html
4848
<ViewPort>
49-
50-
<Layer zIndex={0}>
51-
<LeftResizable size="20%" /> // floating sidebar
52-
</Layer>
53-
54-
<Layer zIndex={1}>
55-
<Fill />
56-
</Layer>
49+
<Layer zIndex="{0}"> <LeftResizable size="20%" /> // floating sidebar </Layer>
5750

51+
<Layer zIndex="{1}">
52+
<Fill />
53+
</Layer>
5854
</ViewPort>
5955
```
6056

61-
**\<Centered /\>**
57+
**\<Centered /\>**
6258

6359
Centres the content of a space horizontally and vertically.
6460

@@ -75,15 +71,16 @@ npm install react-spaces --save
7571
```
7672

7773
```typescript
78-
import * as Spaces from 'react-spaces';
74+
import * as Spaces from "react-spaces";
7975
```
8076

8177
View full documentation [here](https://www.allaneagle.com/react-spaces/demo/).
8278

8379
## Donation
80+
8481
If you find this library useful, consider making a small donation to fund a cup of coffee:
8582

8683
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=AAYPWGUQBUDAA"
8784
title="If you find this library useful, consider making a small donation to fund a cup of coffee" alt="Make Donation" style="text-decoration: none;">
88-
<img src="https://www.allaneagle.com/donation.png" />
85+
<img src="https://www.allaneagle.com/donation.png" />
8986
</a>

0 commit comments

Comments
 (0)