Skip to content

Commit

Permalink
support events as array + more docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sag1v committed Oct 20, 2018
1 parent 9a308bb commit 36381eb
Show file tree
Hide file tree
Showing 58 changed files with 5,088 additions and 4,934 deletions.
103 changes: 71 additions & 32 deletions .docz/app/db.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,20 @@
}
}
},
"menu": [],
"ordering": "ascending",
"menu": [
"Getting started",
{
"name": "Examples",
"menu": [
"event",
"ref",
"on & off",
"multiple events",
"preventDefault"
]
}
],
"ordering": "descending",
"version": "1.0.2",
"repository": "https://github.com/sag1v/react-trap",
"native": false,
Expand Down Expand Up @@ -85,15 +97,15 @@
}
]
},
"mdx/mouseover.mdx": {
"mdx/event.mdx": {
"name": "event",
"order": 2,
"route": "/event",
"menu": "Examples",
"id": "d6aa0616c3b0ec7804c355d8639892f1",
"filepath": "mdx/mouseover.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/mouseover.mdx",
"slug": "mdx-mouseover",
"id": "069d0e1b9e7f447c7cc0a25c780825fe",
"filepath": "mdx/event.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/event.mdx",
"slug": "mdx-event",
"order": 0,
"headings": [
{
"depth": 1,
Expand All @@ -107,15 +119,37 @@
}
]
},
"mdx/multipleEvents.mdx": {
"name": "multiple events",
"route": "/multipleEvents",
"menu": "Examples",
"id": "73c4522299b5eaf989d460c5015441d0",
"filepath": "mdx/multipleEvents.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/multipleEvents.mdx",
"slug": "mdx-multiple-events",
"order": 0,
"headings": [
{
"depth": 1,
"slug": "multiple-events",
"value": "multiple events"
},
{
"depth": 4,
"slug": "you-can-pass-multiple-events-to-the-event-on-and-off-props-just-pass-a-string-with-events-seperated-by-spaces",
"value": "You can pass multiple events to the event , on and off props, just pass a string with events seperated by spaces."
}
]
},
"mdx/onoffEvents.mdx": {
"name": "on & off",
"order": 3,
"route": "/onoff",
"menu": "Examples",
"id": "7608ac7618c19ec50004a357c7b4ae6d",
"filepath": "mdx/onoffEvents.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/onoffEvents.mdx",
"slug": "mdx-onoff-events",
"order": 0,
"headings": [
{
"depth": 1,
Expand All @@ -129,37 +163,15 @@
}
]
},
"mdx/multipleEvents.mdx": {
"name": "multiple events",
"order": 4,
"route": "/multipleEvents",
"menu": "Examples",
"id": "73c4522299b5eaf989d460c5015441d0",
"filepath": "mdx/multipleEvents.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/multipleEvents.mdx",
"slug": "mdx-multiple-events",
"headings": [
{
"depth": 1,
"slug": "multiple-events",
"value": "multiple events"
},
{
"depth": 4,
"slug": "you-can-multiple-events-to-the-event-on-and-off-props-just-pass-a-string-with-events-seperated-by-spaces",
"value": "You can multiple events to the event , on and off props, just pass a string with events seperated by spaces."
}
]
},
"mdx/preventDefault.mdx": {
"name": "preventDefault",
"order": 3,
"route": "/preventDefault",
"menu": "Examples",
"id": "121e63a9c6c09fdb5a74c064e2003a6d",
"filepath": "mdx/preventDefault.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/preventDefault.mdx",
"slug": "mdx-prevent-default",
"order": 0,
"headings": [
{
"depth": 1,
Expand All @@ -172,6 +184,33 @@
"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"
}
]
},
"mdx/ref.mdx": {
"name": "ref",
"route": "/ref",
"menu": "Examples",
"id": "665ee83f85e8b9bfb807288aadd2f65d",
"filepath": "mdx/ref.mdx",
"link": "https://github.com/sag1v/react-trap\\edit\\master\\src\\docs\\mdx/ref.mdx",
"slug": "mdx-ref",
"order": 0,
"headings": [
{
"depth": 1,
"slug": "ref",
"value": "ref"
},
{
"depth": 4,
"slug": "you-will-need-to-use-the-ref-callback-provided-by-react-trap",
"value": "You will need to use the ref callback provided by react-trap ."
},
{
"depth": 3,
"slug": "why-do-we-must-use-a-ref-prop",
"value": "Why do we must use a ref prop?"
}
]
}
}
}
10 changes: 6 additions & 4 deletions .docz/app/imports.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
export const imports = {
'mdx/index.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-index" */ 'mdx/index.mdx'),
'mdx/mouseover.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-mouseover" */ 'mdx/mouseover.mdx'),
'mdx/onoffEvents.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-onoff-events" */ 'mdx/onoffEvents.mdx'),
'mdx/event.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-event" */ 'mdx/event.mdx'),
'mdx/multipleEvents.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-multiple-events" */ 'mdx/multipleEvents.mdx'),
'mdx/onoffEvents.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-onoff-events" */ 'mdx/onoffEvents.mdx'),
'mdx/preventDefault.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-prevent-default" */ 'mdx/preventDefault.mdx'),
'mdx/ref.mdx': () =>
import(/* webpackPrefetch: true, webpackChunkName: "mdx-ref" */ 'mdx/ref.mdx'),
}
1 change: 1 addition & 0 deletions .docz/cache/045b9c4ab29d236b3fb59fe8368cef68.json
Original file line number Diff line number Diff line change
@@ -0,0 +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 "]}]}
1 change: 1 addition & 0 deletions .docz/cache/064bef21cf5449b1409ea5677b4fbada.json

Large diffs are not rendered by default.

Loading

0 comments on commit 36381eb

Please sign in to comment.