Skip to content

Commit 36381eb

Browse files
committed
support events as array + more docs
1 parent 9a308bb commit 36381eb

File tree

58 files changed

+5088
-4934
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+5088
-4934
lines changed

.docz/app/db.json

+71-32
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,20 @@
1919
}
2020
}
2121
},
22-
"menu": [],
23-
"ordering": "ascending",
22+
"menu": [
23+
"Getting started",
24+
{
25+
"name": "Examples",
26+
"menu": [
27+
"event",
28+
"ref",
29+
"on & off",
30+
"multiple events",
31+
"preventDefault"
32+
]
33+
}
34+
],
35+
"ordering": "descending",
2436
"version": "1.0.2",
2537
"repository": "https://github.com/sag1v/react-trap",
2638
"native": false,
@@ -85,15 +97,15 @@
8597
}
8698
]
8799
},
88-
"mdx/mouseover.mdx": {
100+
"mdx/event.mdx": {
89101
"name": "event",
90-
"order": 2,
91102
"route": "/event",
92103
"menu": "Examples",
93-
"id": "d6aa0616c3b0ec7804c355d8639892f1",
94-
"filepath": "mdx/mouseover.mdx",
95-
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/mouseover.mdx",
96-
"slug": "mdx-mouseover",
104+
"id": "069d0e1b9e7f447c7cc0a25c780825fe",
105+
"filepath": "mdx/event.mdx",
106+
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/event.mdx",
107+
"slug": "mdx-event",
108+
"order": 0,
97109
"headings": [
98110
{
99111
"depth": 1,
@@ -107,15 +119,37 @@
107119
}
108120
]
109121
},
122+
"mdx/multipleEvents.mdx": {
123+
"name": "multiple events",
124+
"route": "/multipleEvents",
125+
"menu": "Examples",
126+
"id": "73c4522299b5eaf989d460c5015441d0",
127+
"filepath": "mdx/multipleEvents.mdx",
128+
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/multipleEvents.mdx",
129+
"slug": "mdx-multiple-events",
130+
"order": 0,
131+
"headings": [
132+
{
133+
"depth": 1,
134+
"slug": "multiple-events",
135+
"value": "multiple events"
136+
},
137+
{
138+
"depth": 4,
139+
"slug": "you-can-pass-multiple-events-to-the-event-on-and-off-props-just-pass-a-string-with-events-seperated-by-spaces",
140+
"value": "You can pass multiple events to the event , on and off props, just pass a string with events seperated by spaces."
141+
}
142+
]
143+
},
110144
"mdx/onoffEvents.mdx": {
111145
"name": "on & off",
112-
"order": 3,
113146
"route": "/onoff",
114147
"menu": "Examples",
115148
"id": "7608ac7618c19ec50004a357c7b4ae6d",
116149
"filepath": "mdx/onoffEvents.mdx",
117150
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/onoffEvents.mdx",
118151
"slug": "mdx-onoff-events",
152+
"order": 0,
119153
"headings": [
120154
{
121155
"depth": 1,
@@ -129,37 +163,15 @@
129163
}
130164
]
131165
},
132-
"mdx/multipleEvents.mdx": {
133-
"name": "multiple events",
134-
"order": 4,
135-
"route": "/multipleEvents",
136-
"menu": "Examples",
137-
"id": "73c4522299b5eaf989d460c5015441d0",
138-
"filepath": "mdx/multipleEvents.mdx",
139-
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/multipleEvents.mdx",
140-
"slug": "mdx-multiple-events",
141-
"headings": [
142-
{
143-
"depth": 1,
144-
"slug": "multiple-events",
145-
"value": "multiple events"
146-
},
147-
{
148-
"depth": 4,
149-
"slug": "you-can-multiple-events-to-the-event-on-and-off-props-just-pass-a-string-with-events-seperated-by-spaces",
150-
"value": "You can multiple events to the event , on and off props, just pass a string with events seperated by spaces."
151-
}
152-
]
153-
},
154166
"mdx/preventDefault.mdx": {
155167
"name": "preventDefault",
156-
"order": 3,
157168
"route": "/preventDefault",
158169
"menu": "Examples",
159170
"id": "121e63a9c6c09fdb5a74c064e2003a6d",
160171
"filepath": "mdx/preventDefault.mdx",
161172
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/preventDefault.mdx",
162173
"slug": "mdx-prevent-default",
174+
"order": 0,
163175
"headings": [
164176
{
165177
"depth": 1,
@@ -172,6 +184,33 @@
172184
"value": "You can pass preventDefault and prevent the default behaviour of the browser. This will prevent the default only if the state has changed, this way we are not over taking other event listeners"
173185
}
174186
]
187+
},
188+
"mdx/ref.mdx": {
189+
"name": "ref",
190+
"route": "/ref",
191+
"menu": "Examples",
192+
"id": "665ee83f85e8b9bfb807288aadd2f65d",
193+
"filepath": "mdx/ref.mdx",
194+
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/ref.mdx",
195+
"slug": "mdx-ref",
196+
"order": 0,
197+
"headings": [
198+
{
199+
"depth": 1,
200+
"slug": "ref",
201+
"value": "ref"
202+
},
203+
{
204+
"depth": 4,
205+
"slug": "you-will-need-to-use-the-ref-callback-provided-by-react-trap",
206+
"value": "You will need to use the ref callback provided by react-trap ."
207+
},
208+
{
209+
"depth": 3,
210+
"slug": "why-do-we-must-use-a-ref-prop",
211+
"value": "Why do we must use a ref prop?"
212+
}
213+
]
175214
}
176215
}
177216
}

.docz/app/imports.js

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
export const imports = {
22
'mdx/index.mdx': () =>
33
import(/* webpackPrefetch: true, webpackChunkName: "mdx-index" */ 'mdx/index.mdx'),
4-
'mdx/mouseover.mdx': () =>
5-
import(/* webpackPrefetch: true, webpackChunkName: "mdx-mouseover" */ 'mdx/mouseover.mdx'),
6-
'mdx/onoffEvents.mdx': () =>
7-
import(/* webpackPrefetch: true, webpackChunkName: "mdx-onoff-events" */ 'mdx/onoffEvents.mdx'),
4+
'mdx/event.mdx': () =>
5+
import(/* webpackPrefetch: true, webpackChunkName: "mdx-event" */ 'mdx/event.mdx'),
86
'mdx/multipleEvents.mdx': () =>
97
import(/* webpackPrefetch: true, webpackChunkName: "mdx-multiple-events" */ 'mdx/multipleEvents.mdx'),
8+
'mdx/onoffEvents.mdx': () =>
9+
import(/* webpackPrefetch: true, webpackChunkName: "mdx-onoff-events" */ 'mdx/onoffEvents.mdx'),
1010
'mdx/preventDefault.mdx': () =>
1111
import(/* webpackPrefetch: true, webpackChunkName: "mdx-prevent-default" */ 'mdx/preventDefault.mdx'),
12+
'mdx/ref.mdx': () =>
13+
import(/* webpackPrefetch: true, webpackChunkName: "mdx-ref" */ 'mdx/ref.mdx'),
1214
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"remainingRequest":"C:\\Users\\sagiv\\github clones\\react-trap\\node_modules\\docz-core\\node_modules\\babel-loader\\lib\\index.js?{\"presets\":[[\"@babel/preset-env\",{\"modules\":false}],\"@babel/preset-react\",[\"C:\\\\Users\\\\sagiv\\\\github clones\\\\react-trap\\\\node_modules\\\\babel-preset-docz\\\\dist\\\\index.js\",{\"flow\":true,\"typescript\":false,\"parseProps\":true}]],\"plugins\":[\"@babel/plugin-proposal-class-properties\",[\"C:\\\\Users\\\\sagiv\\\\github clones\\\\react-trap\\\\node_modules\\\\docz-utils\\\\lib\\\\named-asset-import.js\",{\"loaderMap\":{\"svg\":{\"ReactComponent\":\"@svgr/webpack?-prettier,-svgo![path]\"}}}],\"C:\\\\Users\\\\sagiv\\\\github clones\\\\react-trap\\\\node_modules\\\\react-hot-loader\\\\babel.js\"],\"cacheDirectory\":true,\"babelrc\":false}!C:\\Users\\sagiv\\github clones\\react-trap\\src\\docs\\mdx\\event.mdx","dependencies":[{"path":"C:\\Users\\sagiv\\github clones\\react-trap\\src\\docs\\mdx\\event.mdx","mtime":1540028015899},{"path":"C:\\Users\\sagiv\\github clones\\react-trap\\node_modules\\cache-loader\\dist\\cjs.js","mtime":1540019648933},{"path":"C:\\Users\\sagiv\\github clones\\react-trap\\node_modules\\docz-core\\node_modules\\babel-loader\\lib\\index.js","mtime":499162500000}],"contextDependencies":[],"result":["var _jsxFileName = \"C:\\\\Users\\\\sagiv\\\\github clones\\\\react-trap\\\\src\\\\docs\\\\mdx\\\\event.mdx\";\n\n(function () {\n var enterModule = require('react-hot-loader').enterModule;\n\n enterModule && enterModule(module);\n})();\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\nimport React from 'react';\nimport { MDXTag } from '@mdx-js/tag';\nimport { Playground } from 'docz';\nimport Trap from 'react-trap';\nimport Box from '../components/Box';\n\nvar _default = function _default(_ref) {\n var components = _ref.components,\n props = _objectWithoutProperties(_ref, [\"components\"]);\n\n return React.createElement(MDXTag, {\n name: \"wrapper\",\n components: components,\n __source: {\n fileName: _jsxFileName,\n lineNumber: 8\n },\n __self: this\n }, React.createElement(MDXTag, {\n name: \"h1\",\n components: components,\n props: {\n \"id\": \"event\"\n },\n __source: {\n fileName: _jsxFileName,\n lineNumber: 9\n },\n __self: this\n }, \"event\"), React.createElement(MDXTag, {\n name: \"h4\",\n components: components,\n props: {\n \"id\": \"you-can-provide-any-valid-dom-event\"\n },\n __source: {\n fileName: _jsxFileName,\n lineNumber: 10\n },\n __self: this\n }, \"You can provide any valid \", React.createElement(MDXTag, {\n name: \"a\",\n components: components,\n parentName: \"h4\",\n props: {\n \"href\": \"https://developer.mozilla.org/en-US/docs/Web/Events\"\n },\n __source: {\n fileName: _jsxFileName,\n lineNumber: 10\n },\n __self: this\n }, \"DOM event\"), \".\"), React.createElement(MDXTag, {\n name: \"p\",\n components: components,\n __source: {\n fileName: _jsxFileName,\n lineNumber: 11\n },\n __self: this\n }, \"In this case we are using the \", React.createElement(MDXTag, {\n name: \"inlineCode\",\n components: components,\n parentName: \"p\",\n __source: {\n fileName: _jsxFileName,\n lineNumber: 11\n },\n __self: this\n }, \"mouseover\"), \" event which will get triggered by a hover of a pointer device or a \", React.createElement(MDXTag, {\n name: \"inlineCode\",\n components: components,\n parentName: \"p\",\n __source: {\n fileName: _jsxFileName,\n lineNumber: 11\n },\n __self: this\n }, \"press\"), \" on mobile.\"), React.createElement(Playground, {\n __position: 0,\n __codesandbox: \"undefined\",\n __code: \"<Trap event=\\\"mouseover\\\">\\n {(trapped, ref) => <Box innerRef={ref} isFocused={trapped} />}\\n</Trap>\",\n __scope: {\n props: props,\n Trap: Trap,\n Box: Box\n },\n __source: {\n fileName: _jsxFileName,\n lineNumber: 12\n },\n __self: this\n }, React.createElement(Trap, {\n event: \"mouseover\",\n __source: {\n fileName: _jsxFileName,\n lineNumber: 15\n },\n __self: this\n }, function (trapped, ref) {\n return React.createElement(Box, {\n innerRef: ref,\n isFocused: trapped,\n __source: {\n fileName: _jsxFileName,\n lineNumber: 16\n },\n __self: this\n });\n })));\n};\n\nexport default _default;\n;\n\n(function () {\n var reactHotLoader = require('react-hot-loader').default;\n\n var leaveModule = require('react-hot-loader').leaveModule;\n\n if (!reactHotLoader) {\n return;\n }\n\n reactHotLoader.register(_default, \"default\", \"C:\\\\Users\\\\sagiv\\\\github clones\\\\react-trap\\\\src\\\\docs\\\\mdx\\\\event.mdx\");\n leaveModule(module);\n})();\n\n;",{"version":3,"sources":["C:\\Users\\sagiv\\github clones\\react-trap\\src\\docs\\mdx\\event.mdx"],"names":["React","MDXTag","Playground","Trap","Box","components","props","trapped","ref"],"mappings":";;;;;;;;;;;;AACE,OAAOA,KAAP,MAAkB,OAAlB;AACA,SAASC,MAAT,QAAuB,aAAvB;AACA,SAAQC,UAAR,QAA0B,MAA1B;AACF,OAAOC,IAAP,MAAiB,YAAjB;AACA,OAAOC,GAAP,MAAgB,mBAAhB;;eAEe;AAAA,MAAEC,UAAF,QAAEA,UAAF;AAAA,MAAiBC,KAAjB;;AAAA,SAA4B,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,SAAb;AAAwB,IAAA,UAAU,EAAED,UAApC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,KAC3C,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,IAAb;AAAkB,IAAA,UAAU,EAAEA,UAA9B;AAA0C,IAAA,KAAK,EAAE;AAAC,YAAK;AAAN,KAAjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,aAD2C,EAE3C,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,IAAb;AAAkB,IAAA,UAAU,EAAEA,UAA9B;AAA0C,IAAA,KAAK,EAAE;AAAC,YAAK;AAAN,KAAjD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mCAA6H,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,GAAb;AAAiB,IAAA,UAAU,EAAEA,UAA7B;AAAyC,IAAA,UAAU,EAAC,IAApD;AAAyD,IAAA,KAAK,EAAE;AAAC,cAAO;AAAR,KAAhE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAA7H,MAF2C,EAG3C,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,GAAb;AAAiB,IAAA,UAAU,EAAEA,UAA7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,uCAA2E,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,YAAb;AAA0B,IAAA,UAAU,EAAEA,UAAtC;AAAkD,IAAA,UAAU,EAAC,GAA7D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,iBAA3E,0EAA0O,oBAAC,MAAD;AAAQ,IAAA,IAAI,EAAC,YAAb;AAA0B,IAAA,UAAU,EAAEA,UAAtC;AAAkD,IAAA,UAAU,EAAC,GAA7D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,aAA1O,gBAH2C,EAI3C,oBAAC,UAAD;AAAY,IAAA,UAAU,EAAE,CAAxB;AAA2B,IAAA,aAAa,aAAxC;AAAuD,IAAA,MAAM,yGAA7D;AAEU,IAAA,OAAO,EAAE;AAACC,MAAAA,KAAK,EAALA,KAAD;AAAOH,MAAAA,IAAI,EAAJA,IAAP;AAAYC,MAAAA,GAAG,EAAHA;AAAZ,KAFnB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,KAGE,oBAAC,IAAD;AAAM,IAAA,KAAK,EAAC,WAAZ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,KACG,UAACG,OAAD,EAAUC,GAAV;AAAA,WAAkB,oBAAC,GAAD;AAAK,MAAA,QAAQ,EAAEA,GAAf;AAAoB,MAAA,SAAS,EAAED,OAA/B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAAlB;AAAA,GADH,CAHF,CAJ2C,CAA5B;AAAA,C;;AAAf","sourcesContent":["\n import React from 'react'\n import { MDXTag } from '@mdx-js/tag'\n import {Playground } from 'docz';\nimport Trap from 'react-trap';\nimport Box from '../components/Box';\n\nexport default ({components, ...props}) => <MDXTag name=\"wrapper\" components={components}>\n<MDXTag name=\"h1\" components={components} props={{\"id\":\"event\"}}>{`event`}</MDXTag>\n<MDXTag name=\"h4\" components={components} props={{\"id\":\"you-can-provide-any-valid-dom-event\"}}>{`You can provide any valid `}<MDXTag name=\"a\" components={components} parentName=\"h4\" props={{\"href\":\"https://developer.mozilla.org/en-US/docs/Web/Events\"}}>{`DOM event`}</MDXTag>{`.`}</MDXTag>\n<MDXTag name=\"p\" components={components}>{`In this case we are using the `}<MDXTag name=\"inlineCode\" components={components} parentName=\"p\">{`mouseover`}</MDXTag>{` event which will get triggered by a hover of a pointer device or a `}<MDXTag name=\"inlineCode\" components={components} parentName=\"p\">{`press`}</MDXTag>{` on mobile.`}</MDXTag>\n<Playground __position={0} __codesandbox={`undefined`} __code={`<Trap event=\"mouseover\">\n {(trapped, ref) => <Box innerRef={ref} isFocused={trapped} />}\n</Trap>`} __scope={{props,Trap,Box}} >\n <Trap event=\"mouseover\">\n {(trapped, ref) => <Box innerRef={ref} isFocused={trapped} />}\n </Trap>\n</Playground></MDXTag>\n "]}]}

.docz/cache/064bef21cf5449b1409ea5677b4fbada.json

+1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)