├── .gitignore
├── LICENSE
├── README.md
├── algolia.png
├── chakra-ui.php
├── composer.json
├── demo.gif
├── google.png
├── icon.png
├── info.plist
└── screenshot.jpg


/.gitignore:
--------------------------------------------------------------------------------
1 | composer.lock
2 | /vendor
3 | .idea
4 | .DS_Store
5 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Daniel Wirtz
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Chakra UI Docs Workflow for Alfred
 2 | 
 3 | A Chakra UI docs search workflow for Alfred 4.
 4 | 
 5 | ![Demo](demo.gif)
 6 | 
 7 | Adapted from [Alfred TailwindCSS Docs](https://github.com/clnt/alfred-tailwindcss-docs), which is adapted itself from the [Alfred VueJS Docs](https://github.com/vmitchell85/alfred-vuejs-docs) and [Alfred Laravel Docs](https://github.com/tillkruss/alfred-laravel-docs).
 8 | 
 9 | ## Installation
10 | 
11 | 1. [Download the latest version](https://github.com/wirtzdan/alfred-chakra-ui-docs/releases)
12 | 2. Install the workflow by double-clicking the `.alfredworkflow` file
13 | 3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.
14 | 
15 | ## Usage
16 | 
17 | To search the [Chakra UI docs](https://chakra-ui.com/docs/getting-started), just type `chakra` followed by your search query.
18 | 
19 | ```
20 | chakra <query>
21 | ```
22 | 
23 | ## Support & Feedback
24 | 
25 | You can write me on [Twitter](https://twitter.com/wirtzdan/), or just open a new issue.
26 | 
27 | ![Search by Algolia](algolia.png)
28 | 


--------------------------------------------------------------------------------
/algolia.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wirtzdan/alfred-chakra-ui-docs/e58cf08271406ca65a90b3a46c516ff9149c8d8b/algolia.png


--------------------------------------------------------------------------------
/chakra-ui.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Alfred\Workflows\Workflow;
 4 | 
 5 | use AlgoliaSearch\Client as Algolia;
 6 | use AlgoliaSearch\Version as AlgoliaUserAgent;
 7 | 
 8 | require __DIR__ . '/vendor/autoload.php';
 9 | 
10 | $query = $argv[1];
11 | //$branch = empty($_ENV['branch']) ? 'master' : $_ENV['branch'];
12 | //$subtext = empty($_ENV['alfred_theme_subtext']) ? '0' : $_ENV['alfred_theme_subtext'];
13 | 
14 | $workflow = new Workflow;
15 | $parsedown = new Parsedown;
16 | $algolia = new Algolia('BH4D9OD16A', 'df1dcc41f7b8e5d68e73dd56d1e19701');
17 | 
18 | AlgoliaUserAgent::addSuffixUserAgentSegment('Chakra UI Alfred Workflow', '1.0.0');
19 | 
20 | $index = $algolia->initIndex('chakra-ui');
21 | $search = $index->search($query);
22 | $results = $search['hits'];
23 | 
24 | $subtextSupported = $subtext === '0' || $subtext === '2';
25 | 
26 | if (empty($results)) {
27 |     if (empty($results)) {
28 |         $workflow->result()
29 |             ->title('No matches')
30 |             ->icon('google.png')
31 |             ->subtitle("No match found in the docs. Search Google for: \"Chakra+UI+{$query}\"")
32 |             ->arg("https://www.google.com/search?q=chakra+ui+{$query}")
33 |             ->quicklookurl("https://www.google.com/search?q=chakra+ui+{$query}")
34 |             ->valid(true);
35 | 
36 |         echo $workflow->output();
37 |         exit;
38 |     }
39 |     exit;
40 | }
41 | 
42 | $urls = [];
43 | 
44 | 
45 | foreach ($results as $hit) {
46 |     $highestLvl = $hit['hierarchy']['lvl6'] ? 6 : (
47 |         $hit['hierarchy']['lvl5'] ? 5 : (
48 |             $hit['hierarchy']['lvl4'] ? 4 : (
49 |                 $hit['hierarchy']['lvl3'] ? 3 : (
50 |                     $hit['hierarchy']['lvl2'] ? 2 : (
51 |                         $hit['hierarchy']['lvl1'] ? 1 : 0
52 |                     )
53 |                 )
54 |             )
55 |         )
56 |     );
57 | 
58 |     $title = $hit['hierarchy']['lvl' . $highestLvl];
59 |     $currentLvl = 0;
60 |     $subtitle = $hit['hierarchy']['lvl0'];
61 |     while ($currentLvl < $highestLvl) {
62 |         $currentLvl = $currentLvl + 1;
63 |         $subtitle = $subtitle . ' » ' . $hit['hierarchy']['lvl' . $currentLvl];
64 |     }
65 | 
66 |     $workflow->result()
67 |         ->uid($hit['objectID'])
68 |         ->title($title)
69 |         ->autocomplete($title)
70 |         ->subtitle($subtitle)
71 |         ->arg($hit['url'])
72 |         ->quicklookurl($hit['url'])
73 |         ->valid(true);
74 | }
75 | 
76 | echo $workflow->output();
77 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "wirtzdan/alfred-chakra-ui-docs",
 3 |   "description": "Chakra UI docs search workflow for Alfred 4.",
 4 |   "version": "1.0.0",
 5 |   "keywords": [
 6 |     "alfred",
 7 |     "alfred-workflow",
 8 |     "chakra-ui",
 9 |     "algolia"
10 |   ],
11 |   "homepage": "https://github.com/wirtzdan",
12 |   "support": {
13 |     "source": "https://github.com/wirtzdan/alfred-chakra-ui-docs",
14 |     "issues": "https://github.com/wirtzdan/alfred-chakra-ui-docs/issues"
15 |   },
16 |   "license": "MIT",
17 |   "require": {
18 |     "joetannenbaum/alfred-workflow": "^0.1.0",
19 |     "algolia/algoliasearch-client-php": "^1.27",
20 |     "erusev/parsedown": "^1.7"
21 |   }
22 | }
23 | 


--------------------------------------------------------------------------------
/demo.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wirtzdan/alfred-chakra-ui-docs/e58cf08271406ca65a90b3a46c516ff9149c8d8b/demo.gif


--------------------------------------------------------------------------------
/google.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wirtzdan/alfred-chakra-ui-docs/e58cf08271406ca65a90b3a46c516ff9149c8d8b/google.png


--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wirtzdan/alfred-chakra-ui-docs/e58cf08271406ca65a90b3a46c516ff9149c8d8b/icon.png


--------------------------------------------------------------------------------
/info.plist:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  3 | <plist version="1.0">
  4 | <dict>
  5 | 	<key>bundleid</key>
  6 | 	<string>com.wirtzdan.chakra-ui-docs</string>
  7 | 	<key>category</key>
  8 | 	<string>Productivity</string>
  9 | 	<key>connections</key>
 10 | 	<dict>
 11 | 		<key>7DC430D5-A7C8-4D12-B10E-144E763EACEE</key>
 12 | 		<array>
 13 | 			<dict>
 14 | 				<key>destinationuid</key>
 15 | 				<string>6D7BB70F-AA13-48F8-B4A5-6185D7B944B2</string>
 16 | 				<key>modifiers</key>
 17 | 				<integer>0</integer>
 18 | 				<key>modifiersubtext</key>
 19 | 				<string></string>
 20 | 				<key>vitoclose</key>
 21 | 				<false/>
 22 | 			</dict>
 23 | 		</array>
 24 | 	</dict>
 25 | 	<key>createdby</key>
 26 | 	<string>Daniel Wirtz</string>
 27 | 	<key>description</key>
 28 | 	<string>Chakra UI docs search workflow</string>
 29 | 	<key>disabled</key>
 30 | 	<false/>
 31 | 	<key>name</key>
 32 | 	<string>Chakra UI Search</string>
 33 | 	<key>objects</key>
 34 | 	<array>
 35 | 		<dict>
 36 | 			<key>config</key>
 37 | 			<dict>
 38 | 				<key>alfredfiltersresults</key>
 39 | 				<false/>
 40 | 				<key>alfredfiltersresultsmatchmode</key>
 41 | 				<integer>0</integer>
 42 | 				<key>argumenttreatemptyqueryasnil</key>
 43 | 				<false/>
 44 | 				<key>argumenttrimmode</key>
 45 | 				<integer>0</integer>
 46 | 				<key>argumenttype</key>
 47 | 				<integer>0</integer>
 48 | 				<key>escaping</key>
 49 | 				<integer>127</integer>
 50 | 				<key>keyword</key>
 51 | 				<string>chakra</string>
 52 | 				<key>queuedelaycustom</key>
 53 | 				<integer>3</integer>
 54 | 				<key>queuedelayimmediatelyinitially</key>
 55 | 				<true/>
 56 | 				<key>queuedelaymode</key>
 57 | 				<integer>0</integer>
 58 | 				<key>queuemode</key>
 59 | 				<integer>1</integer>
 60 | 				<key>runningsubtext</key>
 61 | 				<string>Searching docs for "{query}"...</string>
 62 | 				<key>script</key>
 63 | 				<string>php chakra-ui.php "{query}"</string>
 64 | 				<key>scriptargtype</key>
 65 | 				<integer>0</integer>
 66 | 				<key>scriptfile</key>
 67 | 				<string></string>
 68 | 				<key>subtext</key>
 69 | 				<string>Search the Chakra UI docs...</string>
 70 | 				<key>title</key>
 71 | 				<string>Search the Chakra UI docs...</string>
 72 | 				<key>type</key>
 73 | 				<integer>0</integer>
 74 | 				<key>withspace</key>
 75 | 				<true/>
 76 | 			</dict>
 77 | 			<key>type</key>
 78 | 			<string>alfred.workflow.input.scriptfilter</string>
 79 | 			<key>uid</key>
 80 | 			<string>7DC430D5-A7C8-4D12-B10E-144E763EACEE</string>
 81 | 			<key>version</key>
 82 | 			<integer>3</integer>
 83 | 		</dict>
 84 | 		<dict>
 85 | 			<key>config</key>
 86 | 			<dict>
 87 | 				<key>browser</key>
 88 | 				<string></string>
 89 | 				<key>spaces</key>
 90 | 				<string></string>
 91 | 				<key>url</key>
 92 | 				<string>{query}</string>
 93 | 				<key>utf8</key>
 94 | 				<true/>
 95 | 			</dict>
 96 | 			<key>type</key>
 97 | 			<string>alfred.workflow.action.openurl</string>
 98 | 			<key>uid</key>
 99 | 			<string>6D7BB70F-AA13-48F8-B4A5-6185D7B944B2</string>
100 | 			<key>version</key>
101 | 			<integer>1</integer>
102 | 		</dict>
103 | 	</array>
104 | 	<key>readme</key>
105 | 	<string></string>
106 | 	<key>uidata</key>
107 | 	<dict>
108 | 		<key>6D7BB70F-AA13-48F8-B4A5-6185D7B944B2</key>
109 | 		<dict>
110 | 			<key>xpos</key>
111 | 			<integer>495</integer>
112 | 			<key>ypos</key>
113 | 			<integer>170</integer>
114 | 		</dict>
115 | 		<key>7DC430D5-A7C8-4D12-B10E-144E763EACEE</key>
116 | 		<dict>
117 | 			<key>colorindex</key>
118 | 			<integer>7</integer>
119 | 			<key>xpos</key>
120 | 			<integer>115</integer>
121 | 			<key>ypos</key>
122 | 			<integer>170</integer>
123 | 		</dict>
124 | 	</dict>
125 | 	<key>webaddress</key>
126 | 	<string>https://github.com/wirtzdan/alfred-chakra-ui-docs</string>
127 | </dict>
128 | </plist>
129 | 


--------------------------------------------------------------------------------
/screenshot.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/wirtzdan/alfred-chakra-ui-docs/e58cf08271406ca65a90b3a46c516ff9149c8d8b/screenshot.jpg


--------------------------------------------------------------------------------