Skip to content

Commit 8cfa785

Browse files
a7ula7ul
committed
updates docs
1 parent aeee567 commit 8cfa785

24 files changed

+1223
-123
lines changed

‎website/docs/api/globals.md

Lines changed: 419 additions & 2 deletions
Large diffs are not rendered by default.

‎website/docs/api/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
id: "index"
3-
title: "@nodegui/react-nodegui - v0.4.0"
3+
title: "@nodegui/react-nodegui"
44
sidebar_label: "README"
55
---
66

7-
# React NodeGUI
7+
# React NodeGui
88

99
[![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui)
1010
[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors)
@@ -32,7 +32,7 @@ Visit: https://react.nodegui.org for docs.
3232

3333
**More screenshots?**
3434

35-
[See examples](https://github.com/nodegui/react-nodegui/tree/master/examples/)
35+
[See examples](https://github.com/nodegui/examples/)
3636

3737
## Features
3838

@@ -128,6 +128,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
128128
</tr>
129129
<tr>
130130
<td align="center"><a href="https://github.com/shubhamzanwar"><img src="https://avatars0.githubusercontent.com/u/15626155?v=4" width="100px;" alt=""/><br /><sub><b>Shubham Zanwar</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=shubhamzanwar" title="Code">💻</a></td>
131+
<td align="center"><a href="https://matrunchyk.com"><img src="https://avatars0.githubusercontent.com/u/2089828?v=4" width="100px;" alt=""/><br /><sub><b>Serhii Matrunchyk</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=matrunchyk" title="Code">💻</a></td>
132+
<td align="center"><a href="https://github.com/Solant"><img src="https://avatars2.githubusercontent.com/u/5971578?v=4" width="100px;" alt=""/><br /><sub><b>Solant</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=Solant" title="Code">💻</a></td>
133+
<td align="center"><a href="https://cbp.io"><img src="https://avatars1.githubusercontent.com/u/995050?v=4" width="100px;" alt=""/><br /><sub><b>Christian Petersen</b></sub></a><br /><a href="https://github.com/nodegui/react-nodegui/commits?author=fnky" title="Code">💻</a></td>
131134
</tr>
132135
</table>
133136

‎website/docs/api/interfaces/_react_proxy_.reactproxycomponent.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
id: "_react_proxy_.reactproxycomponent"
3+
title: "ReactProxyComponent"
4+
sidebar_label: "ReactProxyComponent"
5+
---
6+
7+
## Hierarchy
8+
9+
* **ReactProxyComponent**
10+
11+
## Index
12+
13+
### Methods
14+
15+
* [get](_react_proxy_.reactproxycomponent.md#get)
16+
* [update](_react_proxy_.reactproxycomponent.md#update)
17+
18+
## Methods
19+
20+
### get
21+
22+
▸ **get**(): *React.ComponentType*
23+
24+
**Returns:** *React.ComponentType*
25+
26+
___
27+
28+
### update
29+
30+
▸ **update**(`Component`: React.ComponentType): *void*
31+
32+
**Parameters:**
33+
34+
Name | Type |
35+
------ | ------ |
36+
`Component` | React.ComponentType |
37+
38+
**Returns:** *void*

‎website/docs/api/interfaces/abstractbuttonprops.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Renderer.render(<App />);
7272

7373
### `Optional` attributes
7474

75-
• **attributes**? : *WidgetAttributesMap*
75+
• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
7676

7777
*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
7878

@@ -103,7 +103,7 @@ ___
103103

104104
### `Optional` geometry
105105

106-
• **geometry**? : *Geometry*
106+
• **geometry**? : *[Geometry](../globals.md#geometry)*
107107

108108
*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
109109

@@ -139,7 +139,7 @@ ___
139139

140140
### `Optional` maxSize
141141

142-
• **maxSize**? : *Size*
142+
• **maxSize**? : *[Size](../globals.md#size)*
143143

144144
*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
145145

@@ -149,7 +149,7 @@ ___
149149

150150
### `Optional` minSize
151151

152-
• **minSize**? : *Size*
152+
• **minSize**? : *[Size](../globals.md#size)*
153153

154154
*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
155155

@@ -179,7 +179,7 @@ ___
179179

180180
### `Optional` pos
181181

182-
• **pos**? : *Position*
182+
• **pos**? : *[Position](../globals.md#position)*
183183

184184
*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
185185

@@ -199,7 +199,7 @@ ___
199199

200200
### `Optional` size
201201

202-
• **size**? : *ViewSize*
202+
• **size**? : *[ViewSize](../globals.md#viewsize)*
203203

204204
*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
205205

@@ -247,7 +247,7 @@ ___
247247

248248
### `Optional` windowFlags
249249

250-
• **windowFlags**? : *WindowFlagsMap*
250+
• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
251251

252252
*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
253253

‎website/docs/api/interfaces/animatedimageprops.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ sidebar_label: "AnimatedImageProps"
4545

4646
### `Optional` attributes
4747

48-
• **attributes**? : *WidgetAttributesMap*
48+
• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
4949

5050
*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
5151

@@ -62,7 +62,7 @@ ___
6262

6363
### `Optional` children
6464

65-
• **children**? : *string | number*
65+
• **children**? : *string | number | Array‹string | number›*
6666

6767
*Inherited from [TextProps](textprops.md).[children](textprops.md#optional-children)*
6868

@@ -90,7 +90,7 @@ ___
9090

9191
### `Optional` geometry
9292

93-
• **geometry**? : *Geometry*
93+
• **geometry**? : *[Geometry](../globals.md#geometry)*
9494

9595
*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
9696

@@ -110,7 +110,7 @@ ___
110110

111111
### `Optional` maxSize
112112

113-
• **maxSize**? : *Size*
113+
• **maxSize**? : *[Size](../globals.md#size)*
114114

115115
*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
116116

@@ -120,7 +120,7 @@ ___
120120

121121
### `Optional` minSize
122122

123-
• **minSize**? : *Size*
123+
• **minSize**? : *[Size](../globals.md#size)*
124124

125125
*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
126126

@@ -158,7 +158,7 @@ ___
158158

159159
### `Optional` pos
160160

161-
• **pos**? : *Position*
161+
• **pos**? : *[Position](../globals.md#position)*
162162

163163
*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
164164

@@ -186,7 +186,7 @@ ___
186186

187187
### `Optional` size
188188

189-
• **size**? : *ViewSize*
189+
• **size**? : *[ViewSize](../globals.md#viewsize)*
190190

191191
*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
192192

@@ -232,7 +232,7 @@ ___
232232

233233
### `Optional` windowFlags
234234

235-
• **windowFlags**? : *WindowFlagsMap*
235+
• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
236236

237237
*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
238238

‎website/docs/api/interfaces/buttonprops.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Renderer.render(<App />);
6363

6464
### `Optional` attributes
6565

66-
• **attributes**? : *WidgetAttributesMap*
66+
• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
6767

6868
*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
6969

@@ -102,7 +102,7 @@ ___
102102

103103
### `Optional` geometry
104104

105-
• **geometry**? : *Geometry*
105+
• **geometry**? : *[Geometry](../globals.md#geometry)*
106106

107107
*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
108108

@@ -142,7 +142,7 @@ ___
142142

143143
### `Optional` maxSize
144144

145-
• **maxSize**? : *Size*
145+
• **maxSize**? : *[Size](../globals.md#size)*
146146

147147
*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
148148

@@ -152,7 +152,7 @@ ___
152152

153153
### `Optional` minSize
154154

155-
• **minSize**? : *Size*
155+
• **minSize**? : *[Size](../globals.md#size)*
156156

157157
*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
158158

@@ -182,7 +182,7 @@ ___
182182

183183
### `Optional` pos
184184

185-
• **pos**? : *Position*
185+
• **pos**? : *[Position](../globals.md#position)*
186186

187187
*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
188188

@@ -202,7 +202,7 @@ ___
202202

203203
### `Optional` size
204204

205-
• **size**? : *ViewSize*
205+
• **size**? : *[ViewSize](../globals.md#viewsize)*
206206

207207
*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
208208

@@ -252,7 +252,7 @@ ___
252252

253253
### `Optional` windowFlags
254254

255-
• **windowFlags**? : *WindowFlagsMap*
255+
• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
256256

257257
*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
258258

‎website/docs/api/interfaces/checkboxprops.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Renderer.render(<App />);
6363

6464
### `Optional` attributes
6565

66-
• **attributes**? : *WidgetAttributesMap*
66+
• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
6767

6868
*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
6969

@@ -102,7 +102,7 @@ ___
102102

103103
### `Optional` geometry
104104

105-
• **geometry**? : *Geometry*
105+
• **geometry**? : *[Geometry](../globals.md#geometry)*
106106

107107
*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
108108

@@ -142,7 +142,7 @@ ___
142142

143143
### `Optional` maxSize
144144

145-
• **maxSize**? : *Size*
145+
• **maxSize**? : *[Size](../globals.md#size)*
146146

147147
*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
148148

@@ -152,7 +152,7 @@ ___
152152

153153
### `Optional` minSize
154154

155-
• **minSize**? : *Size*
155+
• **minSize**? : *[Size](../globals.md#size)*
156156

157157
*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
158158

@@ -182,7 +182,7 @@ ___
182182

183183
### `Optional` pos
184184

185-
• **pos**? : *Position*
185+
• **pos**? : *[Position](../globals.md#position)*
186186

187187
*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
188188

@@ -202,7 +202,7 @@ ___
202202

203203
### `Optional` size
204204

205-
• **size**? : *ViewSize*
205+
• **size**? : *[ViewSize](../globals.md#viewsize)*
206206

207207
*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
208208

@@ -252,7 +252,7 @@ ___
252252

253253
### `Optional` windowFlags
254254

255-
• **windowFlags**? : *WindowFlagsMap*
255+
• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
256256

257257
*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
258258

0 commit comments

Comments
 (0)