status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Overhaul the Flexbox documentation 

Summary: Closes https://github.com/facebook/react-native/pull/8395

Differential Revision: D3482652

Pulled By: lacker

fbshipit-source-id: 0bf8955341221b74f69ba24dcf5ab332c910a52c
This commit is contained in:
Kevin Lacker 2016-06-24 11:47:23 -07:00 committed by Facebook Github Bot 8
parent 9dd37f6c07
commit 64cdc3547c
3 changed files with 270 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

273
Libraries/StyleSheet/LayoutPropTypes.js
View File

@ -20,48 +20,252 @@ var ReactPropTypes = require('ReactPropTypes');
*
* The implementation in css-layout is slightly different from what the
* Flexbox spec defines - for example, we chose more sensible default
* values. Please refer to the css-layout README for details.
* values. Since our layout docs are generated from the comments in this
* file, please keep a brief comment describing each prop type.
*
* These properties are a subset of our styles that are consumed by the layout
* algorithm and affect the positioning and sizing of views.
*/
var LayoutPropTypes = {
/** `width` sets the width of this component.
*
* It works similarly to `width` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
* See http://www.w3schools.com/cssref/pr_dim_width.asp for more details.
*/
width: ReactPropTypes.number,
/** `height` sets the height of this component.
*
* It works similarly to `height` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
* See http://www.w3schools.com/cssref/pr_dim_width.asp for more details.
*/
height: ReactPropTypes.number,
/** `top` is the number of logical pixels to offset the top edge of
* this component.
*
* It works similarly to `top` in CSS, but in React Native you must
* use logical pixel units, rather than percents, ems, or any of that.
*
* See https://developer.mozilla.org/en-US/docs/Web/CSS/top
* for more details of how `top` affects layout.
*/
top: ReactPropTypes.number,
/** `left` is the number of logical pixels to offset the left edge of
* this component.
*
* It works similarly to `left` in CSS, but in React Native you must
* use logical pixel units, rather than percents, ems, or any of that.
*
* See https://developer.mozilla.org/en-US/docs/Web/CSS/left
* for more details of how `left` affects layout.
*/
left: ReactPropTypes.number,
/** `right` is the number of logical pixels to offset the right edge of
* this component.
*
* It works similarly to `right` in CSS, but in React Native you must
* use logical pixel units, rather than percents, ems, or any of that.
*
* See https://developer.mozilla.org/en-US/docs/Web/CSS/right
* for more details of how `right` affects layout.
*/
right: ReactPropTypes.number,
/** `bottom` is the number of logical pixels to offset the bottom edge of
* this component.
*
* It works similarly to `bottom` in CSS, but in React Native you must
* use logical pixel units, rather than percents, ems, or any of that.
*
* See https://developer.mozilla.org/en-US/docs/Web/CSS/bottom
* for more details of how `top` affects layout.
*/
bottom: ReactPropTypes.number,
/** `minWidth` is the minimum width for this component, in logical pixels.
*
* It works similarly to `min-width` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
*
* See http://www.w3schools.com/cssref/pr_dim_min-width.asp
* for more details.
*/
minWidth: ReactPropTypes.number,
/** `maxWidth` is the maximum width for this component, in logical pixels.
*
* It works similarly to `max-width` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
*
* See http://www.w3schools.com/cssref/pr_dim_max-width.asp
* for more details.
*/
maxWidth: ReactPropTypes.number,
/** `minHeight` is the minimum height for this component, in logical pixels.
*
* It works similarly to `min-height` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
*
* See http://www.w3schools.com/cssref/pr_dim_min-height.asp
* for more details.
*/
minHeight: ReactPropTypes.number,
/** `maxHeight` is the maximum height for this component, in logical pixels.
*
* It works similarly to `max-height` in CSS, but in React Native you
* must use logical pixel units, rather than percents, ems, or any of that.
*
* See http://www.w3schools.com/cssref/pr_dim_max-height.asp
* for more details.
*/
maxHeight: ReactPropTypes.number,
/** Setting `margin` has the same effect as setting each of
* `marginTop`, `marginLeft`, `marginBottom`, and `marginRight`.
*/
margin: ReactPropTypes.number,
/** Setting `marginVertical` has the same effect as setting both
* `marginTop` and `marginBottom`.
*/
marginVertical: ReactPropTypes.number,
/** Setting `marginHorizontal` has the same effect as setting
* both `marginLeft` and `marginRight`.
*/
marginHorizontal: ReactPropTypes.number,
/** `marginTop` works like `margin-top` in CSS.
* See http://www.w3schools.com/cssref/pr_margin-top.asp
* for more details.
*/
marginTop: ReactPropTypes.number,
/** `marginBottom` works like `margin-bottom` in CSS.
* See http://www.w3schools.com/cssref/pr_margin-bottom.asp
* for more details.
*/
marginBottom: ReactPropTypes.number,
/** `marginLeft` works like `margin-left` in CSS.
* See http://www.w3schools.com/cssref/pr_margin-left.asp
* for more details.
*/
marginLeft: ReactPropTypes.number,
/** `marginRight` works like `margin-right` in CSS.
* See http://www.w3schools.com/cssref/pr_margin-right.asp
* for more details.
*/
marginRight: ReactPropTypes.number,
/** `padding` works like `padding` in CSS.
* It's like setting each of `paddingTop`, `paddingBottom`,
* `paddingLeft`, and `paddingRight` to the same thing.
* See http://www.w3schools.com/css/css_padding.asp
* for more details.
*/
padding: ReactPropTypes.number,
/** Setting `paddingVertical` is like setting both of
* `paddingTop` and `paddingBottom`.
*/
paddingVertical: ReactPropTypes.number,
/** Setting `paddingHorizontal` is like setting both of
* `paddingLeft` and `paddingRight`.
*/
paddingHorizontal: ReactPropTypes.number,
/** `paddingTop` works like `padding-top` in CSS.
* See http://www.w3schools.com/cssref/pr_padding-top.asp
* for more details.
*/
paddingTop: ReactPropTypes.number,
/** `paddingBottom` works like `padding-bottom` in CSS.
* See http://www.w3schools.com/cssref/pr_padding-bottom.asp
* for more details.
*/
paddingBottom: ReactPropTypes.number,
/** `paddingLeft` works like `padding-left` in CSS.
* See http://www.w3schools.com/cssref/pr_padding-left.asp
* for more details.
*/
paddingLeft: ReactPropTypes.number,
/** `paddingRight` works like `padding-right` in CSS.
* See http://www.w3schools.com/cssref/pr_padding-right.asp
* for more details.
*/
paddingRight: ReactPropTypes.number,
/** `borderWidth` works like `border-width` in CSS.
* See http://www.w3schools.com/cssref/pr_border-width.asp
* for more details.
*/
borderWidth: ReactPropTypes.number,
/** `borderTopWidth` works like `border-top-width` in CSS.
* See http://www.w3schools.com/cssref/pr_border-top_width.asp
* for more details.
*/
borderTopWidth: ReactPropTypes.number,
/** `borderRightWidth` works like `border-right-width` in CSS.
* See http://www.w3schools.com/cssref/pr_border-right_width.asp
* for more details.
*/
borderRightWidth: ReactPropTypes.number,
/** `borderBottomWidth` works like `border-bottom-width` in CSS.
* See http://www.w3schools.com/cssref/pr_border-bottom_width.asp
* for more details.
*/
borderBottomWidth: ReactPropTypes.number,
/** `borderLeftWidth` works like `border-left-width` in CSS.
* See http://www.w3schools.com/cssref/pr_border-bottom_width.asp
* for more details.
*/
borderLeftWidth: ReactPropTypes.number,
/** `position` in React Native is similar to regular CSS, but
* everything is set to `relative` by default, so `absolute`
* positioning is always just relative to the parent.
*
* If you want to position a child using specific numbers of logical
* pixels relative to its parent, set the child to have `absolute`
* position.
*
* If you want to position a child relative to something
* that is not its parent, just don't use styles for that. Use the
* component tree.
*
* See https://github.com/facebook/css-layout
* for more details on how `position` differs between React Native
* and CSS.
*/
position: ReactPropTypes.oneOf([
'absolute',
'relative'
]),
// https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction
/** `flexDirection` controls which directions children of a container go.
* `row` goes left to right, `column` goes top to bottom, and you may
* be able to guess what the other two do. It works like `flex-direction`
* in CSS, except the default is `column`. See
* https://css-tricks.com/almanac/properties/f/flex-direction/
* for more detail.
*/
flexDirection: ReactPropTypes.oneOf([
'row',
'row-reverse',
@ -69,14 +273,24 @@ var LayoutPropTypes = {
'column-reverse'
]),
// https://developer.mozilla.org/en-US/docs/Web/CSS/flex-wrap
/** `flexWrap` controls whether children can wrap around after they
* hit the end of a flex container.
* It works like `flex-wrap` in CSS. See
* https://css-tricks.com/almanac/properties/f/flex-wrap/
* for more detail.
*/
flexWrap: ReactPropTypes.oneOf([
'wrap',
'nowrap'
]),
// How to align children in the main direction
// https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content
/** `justifyContent` aligns children in the main direction.
* For example, if children are flowing vertically, `justifyContent`
* controls how they align vertically.
* It works like `justify-content` in CSS. See
* https://css-tricks.com/almanac/properties/j/justify-content/
* for more detail.
*/
justifyContent: ReactPropTypes.oneOf([
'flex-start',
'flex-end',
@ -85,8 +299,14 @@ var LayoutPropTypes = {
'space-around'
]),
// How to align children in the cross direction
// https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
/** `alignItems` aligns children in the cross direction.
* For example, if children are flowing vertically, `alignItems`
* controls how they align horizontally.
* It works like `align-items` in CSS, except the default value
* is `stretch` instead of `flex-start`. See
* https://css-tricks.com/almanac/properties/a/align-items/
* for more detail.
*/
alignItems: ReactPropTypes.oneOf([
'flex-start',
'flex-end',
@ -94,8 +314,12 @@ var LayoutPropTypes = {
'stretch'
]),
// How to align the element in the cross direction
// https://developer.mozilla.org/en-US/docs/Web/CSS/align-items
/** `alignSelf` controls how a child aligns in the cross direction,
* overriding the `alignItems` of the parent. It works like `align-self`
* in CSS. See
* https://css-tricks.com/almanac/properties/a/align-self/
* for more detail.
*/
alignSelf: ReactPropTypes.oneOf([
'auto',
'flex-start',
@ -104,10 +328,37 @@ var LayoutPropTypes = {
'stretch'
]),
// https://developer.mozilla.org/en-US/docs/Web/CSS/flex
/** In React Native `flex` does not work the same way that it does in CSS.
* `flex` is a number rather than a string, and it works
* according to the `css-layout` library
* at https://github.com/facebook/css-layout .
*
* When `flex` is a positive number, it makes the component flexible
* and it will be sized proportional to its flex value. So a
* component with `flex` set to 2 will take twice the space as a
* component with `flex` set to 1.
*
* When `flex` is 0, the component is sized according to `width`
* and `height` and it is inflexible.
*
* When `flex` is -1, the component is normally sized according
* `width` and `height`. However, if there's not enough space,
* the component will shrink to its `minWidth` and `minHeight`.
*/
flex: ReactPropTypes.number,
// https://developer.mozilla.org/en-US/docs/Web/CSS/z-index
/** `zIndex` controls which components display on top of others.
* Normally, you don't use `zIndex`. Components render according to
* their order in the document tree, so later components draw over
* earlier ones. `zIndex` may be useful if you have animations or custom
* modal interfaces where you don't want this behavior.
*
* It works like the CSS `z-index` property - components with a larger
* `zIndex` will render on top. Think of the z-direction like it's
* pointing from the phone into your eyeball. See
* https://developer.mozilla.org/en-US/docs/Web/CSS/z-index for
* more detail.
*/
zIndex: ReactPropTypes.number,
};

10
docs/Basics-Layout.md
View File

@ -1,9 +1,9 @@
---
id: basics-layout
title: Layout
title: Layout with Flexbox
layout: docs
category: The Basics
permalink: docs/basics-layout.html
permalink: docs/flexbox.html
next: basics-component-textinput
---
@ -11,7 +11,7 @@ A component can specify the layout of its children using the flexbox algorithm.
You will normally use a combination of `flexDirection`, `alignItems`, and `justifyContent` to achieve the right layout.
> Flexbox works the same way in React Native as it does in CSS on the web, with a few exceptions. The most notable one: the defaults are different, with `flexDirection` defaulting to `column` instead of `row`, and `alignItems` defaulting to `stretch` instead of `flex-start`.
> Flexbox works the same way in React Native as it does in CSS on the web, with a few exceptions. The defaults are different, with `flexDirection` defaulting to `column` instead of `row`, and `alignItems` defaulting to `stretch` instead of `flex-start`, and the `flex` parameter only supports a single number.
#### Flex Direction
@ -99,6 +99,6 @@ class AlignItemsBasics {
AppRegistry.registerComponent('AwesomeProject', () => AlignItemsBasics);
```
#### API Reference
#### Going Deeper
We've covered the basics, but there are many other styles you may need for layouts. The full list is available [here](./docs/flexbox.html).
We've covered the basics, but there are many other styles you may need for layouts. The full list of props that control layout is documented [here](./docs/layout-props.html).

4
website/server/extractDocs.js
View File

@ -39,7 +39,9 @@ function removeExtName(filepath) {
function getNameFromPath(filepath) {
filepath = removeExtName(filepath);
if (filepath === 'LayoutPropTypes') {
return 'Flexbox';
return 'Layout Props';
} else if (filepath == 'ShadowPropTypesIOS') {
return 'Shadow Props';
} else if (filepath === 'TransformPropTypes') {
return 'Transforms';
} else if (filepath === 'TabBarItemIOS') {