-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpackage.json
227 lines (227 loc) · 15.7 KB
/
package.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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
{
"name": "tool-bar",
"version": "2.0.8",
"description": "Package providing customisable tool bar",
"keywords": [
"toolbar",
"tool-bar",
"service"
],
"license": "MIT",
"main": "./lib/tool-bar",
"repository": {
"url": "git+https://github.com/suda/tool-bar.git"
},
"scripts": {
"lint": "eslint --format tap . && remark ."
},
"dependencies": {
"grim": "^2.0.0",
"jquery": "^3.0.0",
"fs-promise": "^2.0.0"
},
"devDependencies": {
"babel-eslint": "^6.0.4",
"eslint": "^2.9.0",
"eslint-config-standard": "^5.2.0",
"eslint-plugin-promise": "^1.1.0",
"eslint-plugin-standard": "^1.3.2",
"remark": "^4.1.1",
"remark-lint": "^3.0.0"
},
"engines": {
"atom": ">=1.0.0"
},
"providedServices": {
"tool-bar": {
"description": "A container for buttons at workspace edge",
"versions": {
"0.1.0": "provideToolBarLegacy",
"1.0.0": "provideToolBar"
}
}
},
"readme": "# Atom Tool Bar\n\n[![Travis CI](https://travis-ci.org/suda/tool-bar.svg?branch=master)](https://travis-ci.org/suda/tool-bar)\n[![Circle CI](https://circleci.com/gh/suda/tool-bar/tree/master.svg?style=svg)](https://circleci.com/gh/suda/tool-bar/tree/master)\n[![AppVeyor](https://ci.appveyor.com/api/projects/status/xtm6u3sn3oil50da?svg=true)](https://ci.appveyor.com/project/suda/tool-bar)\n[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/suda/tool-bar?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\nThis package provides extensible tool bar for Atom.\n\n**Note:** this package by itself adds an empty toolbar. To propagate it with\nicons you can [install plugins](#plugins).\n\n![Horizontal](http://cl.ly/image/2w0u3c1x1K3W/Screenshot-2015-04-21-16.46.49.png)\n\n![Vertical](http://cl.ly/image/1t3U3F191p35/Screenshot-2015-04-21-16.45.46.png)\n\n![Different Sizes](http://cl.ly/image/3v1N2F3e3I47/Screenshot-2015-04-21-16.45.46_2.png)\n\n![Light Theme](http://cl.ly/image/0g043b1e0P1X/Screenshot-2015-04-21-16.46.02.png)\n\n## Configuration\n\n### Position\n\nOn which edge of the editor should the tool bar appear. Possible options:\n\n* Top\n* Right\n* Bottom\n* Left\n\n### Icon size\n\n* Very Small *(12px)*\n* Small *(16px)*\n* Big *(24px)*\n* Large *(32px)*\n\n### Visibility\n\n* Visible\n* Hidden\n\n### Full Width (available in Atom >= 1.7)\n\nWhen on top/bottom, expand to full window width.\n\n## Plugins\n\n* [Flex Tool Bar](https://atom.io/packages/flex-tool-bar)\n* [Tool Bar Main](https://atom.io/packages/tool-bar-main)\n* [Toolbar Almighty](https://atom.io/packages/tool-bar-almighty)\n* [Toolbar for Atom](https://atom.io/packages/tool-bar-atom)\n* [Toolbar Shortcuts](https://atom.io/packages/tool-bar-shortcuts)\n* And [more](https://atom.io/packages/search?utf8=%E2%9C%93&q=keyword%3Atool-bar)...\n\n## Packages using tool-bar\n\n* [Particle Dev](https://atom.io/packages/spark-dev)\n* [Facebook Nuclide](https://atom.io/packages/nuclide)\n* [PlatformIO IDE](https://atom.io/packages/platformio-ide)\n\n## Integrating instructions\n\nBy itself this package shows an empty tool bar. To add buttons and spacers to\nthe tool bar, follow the instructions below.\n\n### Package.json\n\nMake sure the following properties are part of your `package.json`.\n\n```json\n\"consumedServices\": {\n \"tool-bar\": {\n \"versions\": {\n \"^0 || ^1\": \"consumeToolBar\"\n }\n }\n}\n```\n\nWe recommend using [Atom-Package-Deps](https://github.com/steelbrain/package-deps) \nin your package for installing dependency packages like this package.\n\n### Main package file\n\nIn your main package file, add the following methods and replace\n`your-package-name` with your package name.\n\n```js\nlet toolBar;\n\nexport function consumeToolBar(getToolBar) {\n toolBar = getToolBar('your-package-name');\n // Add buttons and spacers here...\n}\n\nexport function deactivate() {\n if (toolBar) {\n toolBar.removeItems();\n toolBar = null;\n }\n}\n```\n\n### Example\n\n```js\nlet toolBar;\n\nexport function consumeToolBar(getToolBar) {\n toolBar = getToolBar('your-package-name');\n\n // Adding button\n toolBar.addButton({\n icon: 'octoface',\n callback: 'application:about',\n tooltip: 'About Atom'\n });\n\n // Adding spacer\n toolBar.addSpacer();\n\n // Using custom icon set (Ionicons)\n const button = toolBar.addButton({\n icon: 'gear-a',\n callback: 'application:show-settings',\n tooltip: 'Show Settings',\n iconset: 'ion'\n });\n\n // Disable button\n button.setEnabled(false);\n\n // Function with data in callback\n toolBar.addButton({\n icon: 'alert',\n callback(data) {\n alert(data);\n },\n tooltip: 'Show Alert',\n data: 'foo'\n });\n\n // Callback with modifiers\n toolBar.addButton({\n icon: 'octoface',\n callback: {\n '': 'application:cmd-1', // Without modifiers is default action\n 'alt': 'application:cmd-2',\n 'ctrl': 'application:cmd-3', // With function callback\n 'shift'(data) {\n console.log(data);\n },\n 'alt+shift': 'application:cmd-5', // Multiple modifiers\n 'alt+ctrl+shift': 'application:cmd-6' // All modifiers \n },\n data: 'foo'\n });\n\n // Adding spacer and button at the beginning of the tool bar\n toolBar.addSpacer({priority: 10});\n toolBar.addButton({\n icon: 'octoface',\n callback: 'application:about',\n priority: 10\n });\n\n // Cleaning up when tool bar is deactivated\n toolBar.onDidDestroy(() => {\n this.toolBar = null;\n // Teardown any stateful code that depends on tool bar ...\n });\n}\n```\n\n## Methods\n\n### `.addButton({icon, callback, priority, tooltip, data})`\n\nThe method `addButton` requires an object with at least the properties `icon`\nand `callback`. The `icon` can be any single icon from the `iconset`. The\n`callback` must be an Atom command string, an custom callback function or an\nobject where the keys are key modifiers (`alt`, `ctrl` or `shift`) and the\nvalues are commands or custom function (see [example](#example)).\n\nThe remaining properties `tooltip` (default there is no tooltip),\n`iconset` (defaults to `Octicons`), `data` and `priority` (defaults `50`)\nare optional.\n\nThe return value of this method shares another method called \n`setEnabled(enabled)` to enable or disable the button.\n\n### `.addSpacer({priority})`\n\nThe method `addSpacer` has only one optional property `priority` (defaults\n`50`).\n\n### `.removeItems()`\n\nUse the method `removeItems` to remove the buttons added by your package. This\nis particular useful in your package `deactivate` method, but can be used at\nany time.\n\n### `.onDidDestroy(callback)`\n\nThe `onDidDestroy` method takes a function that will be called when the\n`tool-bar` package is destroyed. This is useful if your package needs to do\ncleanup when the `tool-bar` is deactivated but your package continues running.\n\n## Supported icon sets\n\n* [Octicons](https://octicons.github.com) (Atom's flavour)\n* [Ionicons](http://ionicons.com) (`ion`)\n* [FontAwesome](http://fortawesome.github.io/Font-Awesome) (`fa`)\n* [Foundation](http://zurb.com/playground/foundation-icon-fonts-3) (`fi`)\n* [IcoMoon](https://icomoon.io) (`icomoon`)\n* [Devicon](http://devicon.fr) (`devicon`)\n* [MaterialDesignIcons](https://materialdesignicons.com/) (`mdi`)\n\n## Supported commands\n\n* `tool-bar:toggle`\n* `tool-bar:position-top`\n* `tool-bar:position-right`\n* `tool-bar:position-bottom`\n* `tool-bar:position-left`\n\n## Authors\n\n* [Wojtek Siudzinski](http://suda.pl) <sup>(owner)</sup>\n* [Jeroen van Warmerdam](https://github.com/jerone)\n* [Ryo Narita](https://github.com/cakecatz)\n\n## Contributors\n\nIssues and pull requests are very welcome. Feel free to write your own packages\nusing this one. For all contributions credits are due:\n\n* [Pascal Bihler](https://github.com/pbihler)\n* [Nikita Gusakov](https://github.com/nkt)\n* Carlos Santos\n* [Daniel Alejandro Cast](https://github.com/lexcast)\n* [James Coyle](https://github.com/JamesCoyle)\n* [Andres Suarez](https://github.com/zertosh)\n",
"readmeFilename": "README.md",
"bugs": {
"url": "https://github.com/suda/tool-bar/issues"
},
"homepage": "https://github.com/suda/tool-bar#readme",
"_id": "tool-bar@1.0.1",
"_shasum": "20fd58e53b6e0bcecf09baa0653dc791c0a0199f",
"_resolved": "file:../d-116710-6523-1hsbz39/package.tgz",
"_from": "../d-116710-6523-1hsbz39/package.tgz",
"_atomModuleCache": {
"version": 1,
"dependencies": [
{
"name": "grim",
"version": "2.0.1",
"path": "node_modules/grim/lib/grim.js"
},
{
"name": "event-kit",
"version": "2.1.0",
"path": "node_modules/grim/node_modules/event-kit/lib/event-kit.js"
},
{
"name": "jquery",
"version": "3.1.0",
"path": "node_modules/jquery/dist/jquery.js"
}
],
"extensions": {
".json": [
".eslintrc.json",
"node_modules/grim/node_modules/event-kit/api.json",
"node_modules/grim/node_modules/event-kit/package.json",
"node_modules/grim/package.json",
"node_modules/jquery/bower.json",
"node_modules/jquery/package.json",
"package.json"
],
".js": [
"lib/tool-bar-button-view.js",
"lib/tool-bar-manager.js",
"lib/tool-bar-spacer-view.js",
"lib/tool-bar-view.js",
"lib/tool-bar.js",
"node_modules/grim/lib/deprecation.js",
"node_modules/grim/lib/grim.js",
"node_modules/grim/node_modules/event-kit/lib/composite-disposable.js",
"node_modules/grim/node_modules/event-kit/lib/disposable.js",
"node_modules/grim/node_modules/event-kit/lib/emitter.js",
"node_modules/grim/node_modules/event-kit/lib/event-kit.js",
"node_modules/jquery/dist/core.js",
"node_modules/jquery/dist/jquery.js",
"node_modules/jquery/dist/jquery.min.js",
"node_modules/jquery/dist/jquery.slim.js",
"node_modules/jquery/dist/jquery.slim.min.js",
"node_modules/jquery/external/sizzle/dist/sizzle.js",
"node_modules/jquery/external/sizzle/dist/sizzle.min.js",
"node_modules/jquery/src/ajax/jsonp.js",
"node_modules/jquery/src/ajax/load.js",
"node_modules/jquery/src/ajax/parseXML.js",
"node_modules/jquery/src/ajax/script.js",
"node_modules/jquery/src/ajax/var/location.js",
"node_modules/jquery/src/ajax/var/nonce.js",
"node_modules/jquery/src/ajax/var/rquery.js",
"node_modules/jquery/src/ajax/xhr.js",
"node_modules/jquery/src/ajax.js",
"node_modules/jquery/src/attributes/attr.js",
"node_modules/jquery/src/attributes/classes.js",
"node_modules/jquery/src/attributes/prop.js",
"node_modules/jquery/src/attributes/support.js",
"node_modules/jquery/src/attributes/val.js",
"node_modules/jquery/src/attributes.js",
"node_modules/jquery/src/callbacks.js",
"node_modules/jquery/src/core/DOMEval.js",
"node_modules/jquery/src/core/access.js",
"node_modules/jquery/src/core/init.js",
"node_modules/jquery/src/core/parseHTML.js",
"node_modules/jquery/src/core/ready-no-deferred.js",
"node_modules/jquery/src/core/ready.js",
"node_modules/jquery/src/core/readyException.js",
"node_modules/jquery/src/core/support.js",
"node_modules/jquery/src/core/var/rsingleTag.js",
"node_modules/jquery/src/core.js",
"node_modules/jquery/src/css/addGetHookIf.js",
"node_modules/jquery/src/css/adjustCSS.js",
"node_modules/jquery/src/css/curCSS.js",
"node_modules/jquery/src/css/hiddenVisibleSelectors.js",
"node_modules/jquery/src/css/showHide.js",
"node_modules/jquery/src/css/support.js",
"node_modules/jquery/src/css/var/cssExpand.js",
"node_modules/jquery/src/css/var/getStyles.js",
"node_modules/jquery/src/css/var/isHiddenWithinTree.js",
"node_modules/jquery/src/css/var/rmargin.js",
"node_modules/jquery/src/css/var/rnumnonpx.js",
"node_modules/jquery/src/css/var/swap.js",
"node_modules/jquery/src/css.js",
"node_modules/jquery/src/data/Data.js",
"node_modules/jquery/src/data/var/acceptData.js",
"node_modules/jquery/src/data/var/dataPriv.js",
"node_modules/jquery/src/data/var/dataUser.js",
"node_modules/jquery/src/data.js",
"node_modules/jquery/src/deferred/exceptionHook.js",
"node_modules/jquery/src/deferred.js",
"node_modules/jquery/src/deprecated.js",
"node_modules/jquery/src/dimensions.js",
"node_modules/jquery/src/effects/Tween.js",
"node_modules/jquery/src/effects/animatedSelector.js",
"node_modules/jquery/src/effects.js",
"node_modules/jquery/src/event/ajax.js",
"node_modules/jquery/src/event/alias.js",
"node_modules/jquery/src/event/focusin.js",
"node_modules/jquery/src/event/support.js",
"node_modules/jquery/src/event/trigger.js",
"node_modules/jquery/src/event.js",
"node_modules/jquery/src/exports/amd.js",
"node_modules/jquery/src/exports/global.js",
"node_modules/jquery/src/jquery.js",
"node_modules/jquery/src/manipulation/_evalUrl.js",
"node_modules/jquery/src/manipulation/buildFragment.js",
"node_modules/jquery/src/manipulation/getAll.js",
"node_modules/jquery/src/manipulation/setGlobalEval.js",
"node_modules/jquery/src/manipulation/support.js",
"node_modules/jquery/src/manipulation/var/rcheckableType.js",
"node_modules/jquery/src/manipulation/var/rscriptType.js",
"node_modules/jquery/src/manipulation/var/rtagName.js",
"node_modules/jquery/src/manipulation/wrapMap.js",
"node_modules/jquery/src/manipulation.js",
"node_modules/jquery/src/offset.js",
"node_modules/jquery/src/queue/delay.js",
"node_modules/jquery/src/queue.js",
"node_modules/jquery/src/selector-native.js",
"node_modules/jquery/src/selector-sizzle.js",
"node_modules/jquery/src/selector.js",
"node_modules/jquery/src/serialize.js",
"node_modules/jquery/src/traversing/findFilter.js",
"node_modules/jquery/src/traversing/var/dir.js",
"node_modules/jquery/src/traversing/var/rneedsContext.js",
"node_modules/jquery/src/traversing/var/siblings.js",
"node_modules/jquery/src/traversing.js",
"node_modules/jquery/src/var/ObjectFunctionString.js",
"node_modules/jquery/src/var/arr.js",
"node_modules/jquery/src/var/class2type.js",
"node_modules/jquery/src/var/concat.js",
"node_modules/jquery/src/var/document.js",
"node_modules/jquery/src/var/documentElement.js",
"node_modules/jquery/src/var/fnToString.js",
"node_modules/jquery/src/var/getProto.js",
"node_modules/jquery/src/var/hasOwn.js",
"node_modules/jquery/src/var/indexOf.js",
"node_modules/jquery/src/var/pnum.js",
"node_modules/jquery/src/var/push.js",
"node_modules/jquery/src/var/rcssNum.js",
"node_modules/jquery/src/var/rnotwhite.js",
"node_modules/jquery/src/var/slice.js",
"node_modules/jquery/src/var/support.js",
"node_modules/jquery/src/var/toString.js",
"node_modules/jquery/src/wrap.js"
]
},
"folders": [
{
"paths": [
"",
"lib",
"spec"
],
"dependencies": {
"grim": "^2.0.0",
"jquery": "^3.0.0"
}
},
{
"paths": [
"node_modules/grim/lib",
"node_modules/grim"
],
"dependencies": {
"event-kit": "^2.0.0"
}
}
]
}
}