-
Notifications
You must be signed in to change notification settings - Fork 25
/
compositor.json
99 lines (99 loc) · 6.52 KB
/
compositor.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
{
"name": "tkh44/react-geolocation",
"version": "0.1.4",
"libraries": {
"xv": "^1.1.25"
},
"title": "react-geolocation",
"branch": "master",
"style": {
"name": "Future",
"componentSet": {
"nav": "nav/BasicNav",
"header": "header/BannerHeader",
"article": "article/BasicArticle",
"footer": "footer/BasicFooter"
},
"fontFamily": "\"Avenir Next\", Helvetica, sans-serif",
"heading": {
"fontWeight": 500,
"textTransform": "uppercase",
"letterSpacing": "0.2em"
},
"alternativeText": {
"textTransform": "uppercase",
"fontWeight": 400,
"letterSpacing": "0.2em",
"opacity": 0.75
},
"colors": {
"text": "#333",
"background": "#fff",
"primary": "#666",
"secondary": "#888",
"highlight": "#1f80ff",
"muted": "#f6f6f6",
"border": "#eee"
},
"layout": {
"centered": true,
"maxWidth": 1024,
"bannerHeight": "80vh"
}
},
"content": [
{
"component": "nav",
"links": [
{
"href": "https://github.com/tkh44/react-geolocation",
"text": "GitHub"
},
{
"href": "https://npmjs.com/package/react-geolocation",
"text": "npm"
}
]
},
{
"component": "header",
"heading": "react-geolocation",
"subhead": "🌎🛰 Declarative geolocation for React",
"children": [
{
"component": "ui/TweetButton",
"text": "react-geolocation: 🌎🛰 Declarative geolocation for React",
"url": ""
},
{
"component": "ui/GithubButton",
"user": "tkh44",
"repo": "react-geolocation"
}
],
"text": "v1.0.2",
"backgroundImage": "",
"image": ""
},
{
"component": "article",
"metadata": {
"source": "github.readme"
},
"html": "\n\n<p><a href=\"https://badge.fury.io/js/react-geolocation\"><img src=\"https://badge.fury.io/js/react-geolocation.svg\"></a>\n<a href=\"https://travis-ci.org/tkh44/react-geolocation\"><img src=\"https://travis-ci.org/tkh44/react-geolocation.svg?branch=master\"></a>\n<a href=\"https://codecov.io/gh/tkh44/react-geolocation\"><img src=\"https://codecov.io/gh/tkh44/react-geolocation/branch/master/graph/badge.svg\"></a></p>\n<ul>\n<li><a href=\"#install\">Install</a></li>\n<li><a href=\"#basic-usage\">Basic Usage</a></li>\n<li><a href=\"#props\">Props</a></li>\n</ul>\n<h2>Install</h2>\n<pre>npm install -S react-geolocation</pre><h2>Basic Usage</h2>\n<pre><Geolocation\n render={({\n fetchingPosition,\n <span class=\"hljs-attr\">position</span>: { <span class=\"hljs-attr\">coords</span>: { latitude, longitude } = {} } = {},\n error,\n getCurrentPosition\n }) =>\n <span class=\"xml\"><span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span>></span>\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">button</span> <span class=\"hljs-attr\">onClick</span>=<span class=\"hljs-string\">{getCurrentPosition}</span>></span>Get Position<span class=\"hljs-tag\"></<span class=\"hljs-name\">button</span>></span>\n {error &&\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span>></span>\n {error.message}\n <span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span>}\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">pre</span>></span>\n latitude: {latitude}\n longitude: {longitude}\n <span class=\"hljs-tag\"></<span class=\"hljs-name\">pre</span>></span>\n <span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span></span>}\n/></pre><h2>Props</h2>\n<h3><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions/enableHighAccuracy\">enableHighAccuracy <code>boolean</code></a></h3>\n<h3><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions/timeout\">timeout <code>number</code></a></h3>\n<h3><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions/maximumAge\">maximumAge <code>number</code></a></h3>\n<h3>render <code>function</code></h3>\n<p><code>render</code> is a function that receives an object as its only argument.</p>\n<p>The object contains the following keys:</p>\n<ul>\n<li>fetchingPosition: <code>bool</code></li>\n<li><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Position\">position</a>: <code>object</code></li>\n<li><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/PositionError\">error</a>: <code>object</code></li>\n<li>getCurrentPosition: <code>function</code></li>\n</ul>\n<h3>lazy <code>boolean</code></h3>\n<p>If true then the component will <strong>not</strong> perform the fetch on mount. \nYou must use the <code>getCurrentPosition</code> named argument in order to initiate the request.</p>\n<pre><Geolocation \n lazy \n render={({getCurrentPosition, fetchingPosition}) => (\n <span class=\"xml\"><span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span>></span>\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">button</span> <span class=\"hljs-attr\">onClick</span>=<span class=\"hljs-string\">{getCurrentPosition}</span>></span>Get Current Position<span class=\"hljs-tag\"></<span class=\"hljs-name\">button</span>></span>\n <span class=\"hljs-tag\"><<span class=\"hljs-name\">div</span>></span>Fetching Position: {fetchingPosition}<span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span>\n <span class=\"hljs-tag\"></<span class=\"hljs-name\">div</span>></span></span>\n )}\n/> \n<span class=\"hljs-comment\">// renders "Fetching Position: false" until the button is clicked</span></pre><h3>onSuccess <code>function</code></h3>\n<p>callback called on success. Its only argument is <code>position</code></p>\n<ul>\n<li><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/Position\">https://developer.mozilla.org/en-US/docs/Web/API/Position</a></li>\n</ul>\n<h3>onError <code>function</code></h3>\n<p>callback called on error. Its only argument is <code>error</code></p>\n<ul>\n<li><a href=\"https://developer.mozilla.org/en-US/docs/Web/API/PositionError\">https://developer.mozilla.org/en-US/docs/Web/API/PositionError</a></li>\n</ul>\n"
},
{
"component": "footer",
"links": [
{
"href": "https://github.com/tkh44/react-geolocation",
"text": "GitHub"
},
{
"href": "https://github.com/tkh44",
"text": "tkh44"
}
]
}
]
}