Skip to content

Commit 96dc857

Browse files
author
Madeline Trotter
committed
Generate docs
1 parent cc5957f commit 96dc857

File tree

3 files changed

+34
-34
lines changed

3 files changed

+34
-34
lines changed

‎generated-docs/React/Basic.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ __*See also:* `ComponentSpec`, `capture`__
141141
#### `Self`
142142

143143
``` purescript
144-
type Self props state action = { props :: props, state :: state, instance_ :: ReactComponentInstance }
144+
type Self props state action = { props :: props, state :: state, instance_ :: ReactComponentInstance props state action }
145145
```
146146

147147
`Self` represents the component instance at a particular point in time.
@@ -421,7 +421,7 @@ __*See also:* `displayNameFromComponent`, `createComponent`__
421421
#### `ReactComponent`
422422

423423
``` purescript
424-
data ReactComponent props
424+
data ReactComponent :: Type -> Type
425425
```
426426

427427
Represents a traditional React component. Useful for JavaScript interop and
@@ -436,7 +436,7 @@ __*See also:* `element`, `toReactComponent`__
436436
#### `ReactComponentInstance`
437437

438438
``` purescript
439-
data ReactComponentInstance
439+
data ReactComponentInstance :: Type -> Type -> Type -> Type
440440
```
441441

442442
An opaque representation of a React component's instance (`this` in the JavaScript

‎generated-docs/React/Basic/DOM.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ __*Note:* Relies on `ReactDOM.unmountComponentAtNode`__
7474
#### `findDOMNode`
7575

7676
``` purescript
77-
findDOMNode :: ReactComponentInstance -> Effect (Either Error Node)
77+
findDOMNode :: forall props state action. ReactComponentInstance props state action -> Effect (Either Error Node)
7878
```
7979

8080
Returns the current DOM node associated with the given
@@ -157,7 +157,7 @@ type Props_var = (children :: Array JSX)
157157
#### `Props_ul`
158158

159159
``` purescript
160-
type Props_ul = (children :: Array JSX, "type" :: String)
160+
type Props_ul = (children :: Array JSX, type :: String)
161161
```
162162

163163
#### `Props_u`
@@ -241,7 +241,7 @@ type Props_table = (children :: Array JSX, summary :: String, width :: String)
241241
#### `Props_svg`
242242

243243
``` purescript
244-
type Props_svg = (accentHeight :: String, accumulate :: String, additive :: String, alignmentBaseline :: String, allowReorder :: String, alphabetic :: String, amplitude :: String, arabicForm :: String, ascent :: String, attributeName :: String, attributeType :: String, autoReverse :: String, azimuth :: String, baseFrequency :: String, baseProfile :: String, baselineShift :: String, bbox :: String, begin :: String, bias :: String, by :: String, calcMode :: String, capHeight :: String, children :: Array JSX, clip :: String, clipPath :: String, clipPathUnits :: String, clipRule :: String, color :: String, colorInterpolation :: String, colorInterpolationFilters :: String, colorProfile :: String, colorRendering :: String, contentScriptType :: String, contentStyleType :: String, cursor :: String, cx :: String, cy :: String, d :: String, decelerate :: String, descent :: String, diffuseConstant :: String, direction :: String, display :: String, divisor :: String, dominantBaseline :: String, dur :: String, dx :: String, dy :: String, edgeMode :: String, elevation :: String, enableBackground :: String, end :: String, exponent :: String, externalResourcesRequired :: String, fill :: String, fillOpacity :: String, fillRule :: String, filter :: String, filterRes :: String, filterUnits :: String, floodColor :: String, floodOpacity :: String, focusable :: String, fontFamily :: String, fontSize :: String, fontSizeAdjust :: String, fontStretch :: String, fontStyle :: String, fontVariant :: String, fontWeight :: String, format :: String, from :: String, fx :: String, fy :: String, g1 :: String, g2 :: String, glyphName :: String, glyphOrientationHorizontal :: String, glyphOrientationVertical :: String, glyphRef :: String, gradientTransform :: String, gradientUnits :: String, hanging :: String, height :: String, horizAdvX :: String, horizOriginX :: String, ideographic :: String, imageRendering :: String, "in" :: String, in2 :: String, intercept :: String, k :: String, k1 :: String, k2 :: String, k3 :: String, k4 :: String, kernelMatrix :: String, kernelUnitLength :: String, kerning :: String, keyPoints :: String, keySplines :: String, keyTimes :: String, lengthAdjust :: String, letterSpacing :: String, lightingColor :: String, limitingConeAngle :: String, local :: String, markerEnd :: String, markerHeight :: String, markerMid :: String, markerStart :: String, markerUnits :: String, markerWidth :: String, mask :: String, maskContentUnits :: String, maskUnits :: String, mathematical :: String, mode :: String, numOctaves :: String, offset :: String, opacity :: String, operator :: String, order :: String, orient :: String, orientation :: String, origin :: String, overflow :: String, overlinePosition :: String, overlineThickness :: String, paintOrder :: String, panose1 :: String, pathLength :: String, patternContentUnits :: String, patternTransform :: String, patternUnits :: String, pointerEvents :: String, points :: String, pointsAtX :: String, pointsAtY :: String, pointsAtZ :: String, preserveAlpha :: String, preserveAspectRatio :: String, primitiveUnits :: String, r :: String, radius :: String, refX :: String, refY :: String, renderingIntent :: String, repeatCount :: String, repeatDur :: String, requiredExtensions :: String, requiredFeatures :: String, restart :: String, result :: String, rotate :: String, rx :: String, ry :: String, scale :: String, seed :: String, shapeRendering :: String, slope :: String, spacing :: String, specularConstant :: String, specularExponent :: String, speed :: String, spreadMethod :: String, startOffset :: String, stdDeviation :: String, stemh :: String, stemv :: String, stitchTiles :: String, stopColor :: String, stopOpacity :: String, strikethroughPosition :: String, strikethroughThickness :: String, string :: String, stroke :: String, strokeDasharray :: String, strokeDashoffset :: String, strokeLinecap :: String, strokeLinejoin :: String, strokeMiterlimit :: String, strokeOpacity :: String, strokeWidth :: String, surfaceScale :: String, systemLanguage :: String, tableValues :: String, targetX :: String, targetY :: String, textAnchor :: String, textDecoration :: String, textLength :: String, textRendering :: String, to :: String, transform :: String, u1 :: String, u2 :: String, underlinePosition :: String, underlineThickness :: String, unicode :: String, unicodeBidi :: String, unicodeRange :: String, unitsPerEm :: String, vAlphabetic :: String, vHanging :: String, vIdeographic :: String, vMathematical :: String, values :: String, vectorEffect :: String, version :: String, vertAdvY :: String, vertOriginX :: String, vertOriginY :: String, viewBox :: String, viewTarget :: String, visibility :: String, width :: String, widths :: String, wordSpacing :: String, writingMode :: String, x :: String, x1 :: String, x2 :: String, xChannelSelector :: String, xHeight :: String, xlinkActuate :: String, xlinkArcrole :: String, xlinkHref :: String, xlinkRole :: String, xlinkShow :: String, xlinkTitle :: String, xlinkType :: String, xmlBase :: String, xmlLang :: String, xmlSpace :: String, xmlns :: String, xmlnsXlink :: String, y :: String, y1 :: String, y2 :: String, yChannelSelector :: String, z :: String, zoomAndPan :: String)
244+
type Props_svg = (accentHeight :: String, accumulate :: String, additive :: String, alignmentBaseline :: String, allowReorder :: String, alphabetic :: String, amplitude :: String, arabicForm :: String, ascent :: String, attributeName :: String, attributeType :: String, autoReverse :: String, azimuth :: String, baseFrequency :: String, baseProfile :: String, baselineShift :: String, bbox :: String, begin :: String, bias :: String, by :: String, calcMode :: String, capHeight :: String, children :: Array JSX, clip :: String, clipPath :: String, clipPathUnits :: String, clipRule :: String, color :: String, colorInterpolation :: String, colorInterpolationFilters :: String, colorProfile :: String, colorRendering :: String, contentScriptType :: String, contentStyleType :: String, cursor :: String, cx :: String, cy :: String, d :: String, decelerate :: String, descent :: String, diffuseConstant :: String, direction :: String, display :: String, divisor :: String, dominantBaseline :: String, dur :: String, dx :: String, dy :: String, edgeMode :: String, elevation :: String, enableBackground :: String, end :: String, exponent :: String, externalResourcesRequired :: String, fill :: String, fillOpacity :: String, fillRule :: String, filter :: String, filterRes :: String, filterUnits :: String, floodColor :: String, floodOpacity :: String, focusable :: String, fontFamily :: String, fontSize :: String, fontSizeAdjust :: String, fontStretch :: String, fontStyle :: String, fontVariant :: String, fontWeight :: String, format :: String, from :: String, fx :: String, fy :: String, g1 :: String, g2 :: String, glyphName :: String, glyphOrientationHorizontal :: String, glyphOrientationVertical :: String, glyphRef :: String, gradientTransform :: String, gradientUnits :: String, hanging :: String, height :: String, horizAdvX :: String, horizOriginX :: String, ideographic :: String, imageRendering :: String, in :: String, in2 :: String, intercept :: String, k :: String, k1 :: String, k2 :: String, k3 :: String, k4 :: String, kernelMatrix :: String, kernelUnitLength :: String, kerning :: String, keyPoints :: String, keySplines :: String, keyTimes :: String, lengthAdjust :: String, letterSpacing :: String, lightingColor :: String, limitingConeAngle :: String, local :: String, markerEnd :: String, markerHeight :: String, markerMid :: String, markerStart :: String, markerUnits :: String, markerWidth :: String, mask :: String, maskContentUnits :: String, maskUnits :: String, mathematical :: String, mode :: String, numOctaves :: String, offset :: String, opacity :: String, operator :: String, order :: String, orient :: String, orientation :: String, origin :: String, overflow :: String, overlinePosition :: String, overlineThickness :: String, paintOrder :: String, panose1 :: String, pathLength :: String, patternContentUnits :: String, patternTransform :: String, patternUnits :: String, pointerEvents :: String, points :: String, pointsAtX :: String, pointsAtY :: String, pointsAtZ :: String, preserveAlpha :: String, preserveAspectRatio :: String, primitiveUnits :: String, r :: String, radius :: String, refX :: String, refY :: String, renderingIntent :: String, repeatCount :: String, repeatDur :: String, requiredExtensions :: String, requiredFeatures :: String, restart :: String, result :: String, rotate :: String, rx :: String, ry :: String, scale :: String, seed :: String, shapeRendering :: String, slope :: String, spacing :: String, specularConstant :: String, specularExponent :: String, speed :: String, spreadMethod :: String, startOffset :: String, stdDeviation :: String, stemh :: String, stemv :: String, stitchTiles :: String, stopColor :: String, stopOpacity :: String, strikethroughPosition :: String, strikethroughThickness :: String, string :: String, stroke :: String, strokeDasharray :: String, strokeDashoffset :: String, strokeLinecap :: String, strokeLinejoin :: String, strokeMiterlimit :: String, strokeOpacity :: String, strokeWidth :: String, surfaceScale :: String, systemLanguage :: String, tableValues :: String, targetX :: String, targetY :: String, textAnchor :: String, textDecoration :: String, textLength :: String, textRendering :: String, to :: String, transform :: String, u1 :: String, u2 :: String, underlinePosition :: String, underlineThickness :: String, unicode :: String, unicodeBidi :: String, unicodeRange :: String, unitsPerEm :: String, vAlphabetic :: String, vHanging :: String, vIdeographic :: String, vMathematical :: String, values :: String, vectorEffect :: String, version :: String, vertAdvY :: String, vertOriginX :: String, vertOriginY :: String, viewBox :: String, viewTarget :: String, visibility :: String, width :: String, widths :: String, wordSpacing :: String, writingMode :: String, x :: String, x1 :: String, x2 :: String, xChannelSelector :: String, xHeight :: String, xlinkActuate :: String, xlinkArcrole :: String, xlinkHref :: String, xlinkRole :: String, xlinkShow :: String, xlinkTitle :: String, xlinkType :: String, xmlBase :: String, xmlLang :: String, xmlSpace :: String, xmlns :: String, xmlnsXlink :: String, y :: String, y1 :: String, y2 :: String, yChannelSelector :: String, z :: String, zoomAndPan :: String)
245245
```
246246

247247
#### `Props_sup`
@@ -265,7 +265,7 @@ type Props_sub = (children :: Array JSX)
265265
#### `Props_style`
266266

267267
``` purescript
268-
type Props_style = (children :: Array JSX, media :: String, nonce :: String, title :: String, "type" :: String)
268+
type Props_style = (children :: Array JSX, media :: String, nonce :: String, title :: String, type :: String)
269269
```
270270

271271
#### `Props_strong`
@@ -283,7 +283,7 @@ type Props_span = (children :: Array JSX)
283283
#### `Props_source`
284284

285285
``` purescript
286-
type Props_source = (media :: String, sizes :: String, src :: String, "type" :: String)
286+
type Props_source = (media :: String, sizes :: String, src :: String, type :: String)
287287
```
288288

289289
#### `Props_small`
@@ -313,7 +313,7 @@ type Props_section = (children :: Array JSX)
313313
#### `Props_script`
314314

315315
``` purescript
316-
type Props_script = (async :: Boolean, children :: Array JSX, defer :: Boolean, integrity :: String, nonce :: String, src :: String, "type" :: String)
316+
type Props_script = (async :: Boolean, children :: Array JSX, defer :: Boolean, integrity :: String, nonce :: String, src :: String, type :: String)
317317
```
318318

319319
#### `Props_samp`
@@ -385,7 +385,7 @@ type Props_picture = (children :: Array JSX)
385385
#### `Props_param`
386386

387387
``` purescript
388-
type Props_param = (name :: String, "type" :: String, value :: String)
388+
type Props_param = (name :: String, type :: String, value :: String)
389389
```
390390

391391
#### `Props_p`
@@ -415,13 +415,13 @@ type Props_optgroup = (children :: Array JSX, disabled :: Boolean, label :: Stri
415415
#### `Props_ol`
416416

417417
``` purescript
418-
type Props_ol = (children :: Array JSX, reversed :: Boolean, start :: Number, "type" :: String)
418+
type Props_ol = (children :: Array JSX, reversed :: Boolean, start :: Number, type :: String)
419419
```
420420

421421
#### `Props_object`
422422

423423
``` purescript
424-
type Props_object = (children :: Array JSX, "data" :: String, form :: String, height :: String, name :: String, "type" :: String, width :: String)
424+
type Props_object = (children :: Array JSX, data :: String, form :: String, height :: String, name :: String, type :: String, width :: String)
425425
```
426426

427427
#### `Props_noscript`
@@ -487,13 +487,13 @@ type Props_main = (children :: Array JSX)
487487
#### `Props_link`
488488

489489
``` purescript
490-
type Props_link = (color :: String, href :: String, integrity :: String, media :: String, nonce :: String, rel :: String, scope :: String, sizes :: String, target :: String, title :: String, "type" :: String)
490+
type Props_link = (color :: String, href :: String, integrity :: String, media :: String, nonce :: String, rel :: String, scope :: String, sizes :: String, target :: String, title :: String, type :: String)
491491
```
492492

493493
#### `Props_li`
494494

495495
``` purescript
496-
type Props_li = (children :: Array JSX, "type" :: String, value :: String)
496+
type Props_li = (children :: Array JSX, type :: String, value :: String)
497497
```
498498

499499
#### `Props_legend`
@@ -529,7 +529,7 @@ type Props_ins = (children :: Array JSX, cite :: String)
529529
#### `Props_input`
530530

531531
``` purescript
532-
type Props_input = (accept :: String, alt :: String, autoCapitalize :: String, autoCorrect :: String, autoSave :: String, checked :: Boolean, defaultChecked :: String, defaultValue :: String, disabled :: Boolean, form :: String, height :: String, list :: String, max :: Number, min :: Number, multiple :: Boolean, name :: String, onChange :: EventHandler, pattern :: String, placeholder :: String, required :: Boolean, results :: String, size :: Number, src :: String, step :: String, title :: String, "type" :: String, value :: String, width :: String)
532+
type Props_input = (accept :: String, alt :: String, autoCapitalize :: String, autoCorrect :: String, autoSave :: String, checked :: Boolean, defaultChecked :: String, defaultValue :: String, disabled :: Boolean, form :: String, height :: String, list :: String, max :: Number, min :: Number, multiple :: Boolean, name :: String, onChange :: EventHandler, pattern :: String, placeholder :: String, required :: Boolean, results :: String, size :: Number, src :: String, step :: String, title :: String, type :: String, value :: String, width :: String)
533533
```
534534

535535
#### `Props_img`
@@ -649,7 +649,7 @@ type Props_fieldset = (children :: Array JSX, disabled :: Boolean, form :: Strin
649649
#### `Props_embed`
650650

651651
``` purescript
652-
type Props_embed = (height :: String, src :: String, "type" :: String, width :: String)
652+
type Props_embed = (height :: String, src :: String, type :: String, width :: String)
653653
```
654654

655655
#### `Props_em`
@@ -757,7 +757,7 @@ type Props_canvas = (children :: Array JSX, height :: String, width :: String)
757757
#### `Props_button`
758758

759759
``` purescript
760-
type Props_button = (children :: Array JSX, disabled :: Boolean, form :: String, name :: String, "type" :: String, value :: String)
760+
type Props_button = (children :: Array JSX, disabled :: Boolean, form :: String, name :: String, type :: String, value :: String)
761761
```
762762

763763
#### `Props_br`
@@ -823,7 +823,7 @@ type Props_article = (children :: Array JSX)
823823
#### `Props_area`
824824

825825
``` purescript
826-
type Props_area = (alt :: String, coords :: String, download :: String, href :: String, rel :: String, shape :: String, target :: String, "type" :: String)
826+
type Props_area = (alt :: String, coords :: String, download :: String, href :: String, rel :: String, shape :: String, target :: String, type :: String)
827827
```
828828

829829
#### `Props_address`
@@ -841,7 +841,7 @@ type Props_abbr = (children :: Array JSX, title :: String)
841841
#### `Props_a`
842842

843843
``` purescript
844-
type Props_a = (children :: Array JSX, coords :: String, download :: String, href :: String, name :: String, onClick :: EventHandler, rel :: String, shape :: String, target :: String, "type" :: String)
844+
type Props_a = (children :: Array JSX, coords :: String, download :: String, href :: String, name :: String, onClick :: EventHandler, rel :: String, shape :: String, target :: String, type :: String)
845845
```
846846

847847
#### `wbr`

0 commit comments

Comments
 (0)