Skip to content

Commit 490cbd0

Browse files
raphamorimraphamorim
committed
update props in docs (closes #38)
1 parent cb5c815 commit 490cbd0

File tree

10 files changed

+477
-12
lines changed

10 files changed

+477
-12
lines changed

‎packages/docs/customcomponents-registercomponent.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
---
22
id: customcomponents-registercomponent
33
title: Custom Components
4-
sidebar_label: Creating and Registering
4+
sidebar_label: Custom Components
55
---
66

7-
87
## Creating Custom Components
98

109
Custom Components allow developers to not limit themselves only to React Ape primitive components (as `Text`, `Image` and etcetera). You can create UI using custom components, however you must leave render pipeline (such as animation updates) to React Ape render process. We strongly recommend to use React state to animate your custom component.

‎packages/docs/style-props-image.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
---
2+
id: style-props-image
3+
title: Image Style Props
4+
sidebar_label: Image Style Props
5+
---
6+
7+
# Reference
8+
9+
## Props
10+
11+
### `backfaceVisibility`
12+
13+
The property defines whether or not the back face of a rotated image should be visible.
14+
15+
| Type | Default |
16+
| ----------------------------- | ----------- |
17+
| enum(`'visible'`, `'hidden'`) | `'visible'` |
18+
19+
---
20+
21+
### `backgroundColor`
22+
23+
| Type |
24+
| ------------------ |
25+
| color (RGB, HSL or named colors according [CSS3/SVG specification](https://www.w3.org/TR/css-color-3/#svg-color)) |
26+
27+
---
28+
29+
### `borderBottomLeftRadius`
30+
31+
| Type |
32+
| ------ |
33+
| number |
34+
35+
---
36+
37+
### `borderBottomRightRadius`
38+
39+
| Type |
40+
| ------ |
41+
| number |
42+
43+
---
44+
45+
### `borderColor`
46+
47+
| Type |
48+
| ------------------ |
49+
| color (RGB, HSL or named colors according [CSS3/SVG specification](https://www.w3.org/TR/css-color-3/#svg-color)) |
50+
51+
---
52+
53+
### `borderRadius`
54+
55+
| Type |
56+
| ------ |
57+
| number |
58+
59+
---
60+
61+
### `borderTopLeftRadius`
62+
63+
| Type |
64+
| ------ |
65+
| number |
66+
67+
---
68+
69+
### `borderTopRightRadius`
70+
71+
| Type |
72+
| ------ |
73+
| number |
74+
75+
---
76+
77+
### `borderWidth`
78+
79+
| Type |
80+
| ------ |
81+
| number |
82+
83+
---
84+
85+
### `opacity`
86+
87+
Set an opacity value for the image. The number should be in the range from `0.0` to `1.0`.
88+
89+
| Type | Default |
90+
| ------ | ------- |
91+
| number | `1.0` |
92+
93+
---
94+
95+
### `overflow`
96+
97+
| Type | Default |
98+
| ----------------------------- | ----------- |
99+
| enum(`'visible'`, `'hidden'`) | `'visible'` |
100+
101+
---
102+
103+
### `resizeMode`
104+
105+
| Type | Default |
106+
| ----------------------------------------------------------------- | --------- |
107+
| enum(`'cover'`, `'contain'`, `'stretch'`, `'repeat'`, `'center'`) | `'cover'` |

‎packages/docs/style-props-text.md‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
id: style-props-text
3+
title: Text Style Props
4+
sidebar_label: Text Style Props
5+
---
6+
7+
# Reference
8+
9+
## Props
10+
11+
### `color`
12+
13+
| Type |
14+
| ------------------ |
15+
| color (RGB, HSL or named colors according [CSS3/SVG specification](https://www.w3.org/TR/css-color-3/#svg-color)) |
16+
17+
---
18+
19+
### `fontFamily`
20+
21+
| Type |
22+
| ------ |
23+
| string |
24+
25+
---
26+
27+
### `fontSize`
28+
29+
| Type |
30+
| ------ |
31+
| number |
32+
33+
---
34+
35+
### `fontStyle`
36+
37+
| Type |
38+
| ---------------------------- |
39+
| enum(`'normal'`, `'italic'`) |
40+
41+
---
42+
43+
### `fontWeight`
44+
45+
Specifies font weight. The values `'normal'` and `'bold'` are supported for most fonts. Not all fonts have a variant for each of the numeric values, in that case the closest one is chosen.
46+
47+
| Type | Default |
48+
| ----------------------------------------------------------------------------------------------------------- | ---------- |
49+
| enum(`'normal'`, `'bold'`, `'100'`, `'200'`, `'300'`, `'400'`, `'500'`, `'600'`, `'700'`, `'800'`, `'900'`) | `'normal'` |
50+
51+
---
52+
53+
### `fontVariant`
54+
55+
| Type | Default |
56+
| ---------------------------------------------------------------------------------------------------------- | ------- |
57+
| array of enum(`'small-caps'`, `'oldstyle-nums'`, `'lining-nums'`, `'tabular-nums'`, `'proportional-nums'`) | `[]` |
58+
59+
---
60+
61+
### `letterSpacing`
62+
63+
Increase or decrease the spacing between characters. By default there is no extra letter spacing.
64+
65+
| Type |
66+
| ------ |
67+
| number |
68+
69+
---
70+
71+
### `lineHeight`
72+
73+
| Type |
74+
| ------ |
75+
| number |
76+
77+
---
78+
79+
### `textAlign`
80+
81+
Specifies text alignment.
82+
83+
| Type | Default |
84+
| ------------------------------------------------------------ | -------- |
85+
| enum(`'auto'`, `'left'`, `'right'`, `'center'`, `'justify'`) | `'auto'` |
86+
87+
---
88+
89+
### `textShadowColor`
90+
91+
| Type |
92+
| ------------------ |
93+
| color (RGB, HSL or named colors according [CSS3/SVG specification](https://www.w3.org/TR/css-color-3/#svg-color)) |
94+
95+
---
96+
97+
### `textTransform`
98+
99+
| Type | Default |
100+
| ------------------------------------------------------------ | -------- |
101+
| enum(`'none'`, `'uppercase'`, `'lowercase'`, `'capitalize'`) | `'none'` |

0 commit comments

Comments
 (0)