Skip to content

Commit a54deb6

Browse files
docs(react-property): update README.md
1 parent f7361e7 commit a54deb6

File tree

1 file changed

+19
-41
lines changed

1 file changed

+19
-41
lines changed

packages/react-property/README.md

Lines changed: 19 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
[![NPM version](https://img.shields.io/npm/v/react-property.svg)](https://www.npmjs.com/package/react-property)
66

7-
[HTML](https://github.com/facebook/react/blob/15-stable/src/renderers/dom/shared/HTMLDOMPropertyConfig.js) and [SVG](https://github.com/facebook/react/blob/15-stable/src/renderers/dom/shared/SVGDOMPropertyConfig.js) [DOM](https://github.com/facebook/react/blob/15-stable/src/renderers/dom/shared/DOMProperty.js) property configs used by [React](https://github.com/facebook/react).
7+
HTML and SVG DOM properties used by [React](https://github.com/facebook/react). See [DOMProperty](https://github.com/facebook/react/blob/main/packages/react-dom/src/shared/DOMProperty.js) and [possibleStandardNames](https://github.com/facebook/react/blob/main/packages/react-dom/src/shared/possibleStandardNames.js).
88

9-
[Repl.it](https://repl.it/@remarkablemark/react-property)
9+
Try [Replit](https://repl.it/@remarkablemark/react-property) demo.
1010

1111
## Install
1212

@@ -16,7 +16,7 @@ npm install react-property
1616

1717
## Usage
1818

19-
Import main module:
19+
Import module:
2020

2121
```js
2222
// CommonJS
@@ -26,50 +26,28 @@ const reactProperty = require('react-property');
2626
import reactProperty from 'react-property';
2727
```
2828

29-
Main module exports:
29+
Module contains:
3030

3131
```js
3232
{
33-
html: {
34-
autofocus: {
35-
attributeName: 'autofocus',
36-
propertyName: 'autoFocus',
37-
mustUseProperty: false,
38-
hasBooleanValue: true,
39-
hasNumericValue: false,
40-
hasPositiveNumericValue: false,
41-
hasOverloadedBooleanValue: false
42-
},
33+
BOOLEAN: 3,
34+
BOOLEANISH_STRING: 2,
35+
NUMERIC: 5,
36+
OVERLOADED_BOOLEAN: 4,
37+
POSITIVE_NUMERIC: 6,
38+
RESERVED: 0,
39+
STRING: 1,
40+
getPropertyInfo: [Function: getPropertyInfo],
41+
isCustomAttribute: [Function: bound test],
42+
possibleStandardNames: {
43+
accept: 'accept',
44+
acceptcharset: 'acceptCharset',
45+
'accept-charset': 'acceptCharset',
4346
// ...
44-
},
45-
svg: {
46-
// ...
47-
},
48-
properties: {
49-
// ...
50-
},
51-
isCustomAttribute: [Function: bound test]
47+
}
5248
}
5349
```
5450

55-
You may also import what you need:
56-
57-
```js
58-
const HTMLDOMPropertyConfig = require('react-property/lib/HTMLDOMPropertyConfig');
59-
const injection = require('react-property/lib/injection');
60-
```
61-
62-
## Layout
63-
64-
```
65-
.
66-
├── index.js
67-
└── lib
68-
   ├── HTMLDOMPropertyConfig.js
69-
   ├── SVGDOMPropertyConfig.js
70-
   └── injection.js
71-
```
72-
7351
## License
7452

75-
MIT. See [license](https://github.com/facebook/react/blob/15-stable/LICENSE) from original project.
53+
MIT. See [license](https://github.com/facebook/react/blob/main/LICENSE) from original project.

0 commit comments

Comments
 (0)