├── .github └── workflows │ ├── cd.yaml │ └── ci.yaml ├── .gitignore ├── LICENSE ├── OWNERS ├── README.md ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── images └── preview.png ├── package.json ├── packages ├── search-widget │ ├── .eslintrc.json │ ├── .gitignore │ ├── .prettierrc.json │ ├── index.html │ ├── lit-localize.json │ ├── package.json │ ├── src │ │ ├── constants │ │ │ └── index.ts │ │ ├── generated │ │ │ ├── locale-codes.ts │ │ │ └── locales │ │ │ │ ├── es.ts │ │ │ │ ├── zh-CN.ts │ │ │ │ └── zh-TW.ts │ │ ├── index.ts │ │ ├── locale │ │ │ └── index.ts │ │ ├── search-form.ts │ │ ├── search-modal.ts │ │ ├── styles │ │ │ ├── base.ts │ │ │ └── var.ts │ │ ├── type.d.ts │ │ └── vite-env.d.ts │ ├── tsconfig.json │ ├── uno.config.ts │ ├── var.css │ ├── vite.config.dev.ts │ ├── vite.config.lib.ts │ └── xliff │ │ ├── es.xlf │ │ ├── zh-CN.xlf │ │ └── zh-TW.xlf └── widget │ ├── .eslintrc.json │ ├── .gitignore │ ├── .prettierrc.json │ ├── package.json │ ├── src │ ├── index.ts │ └── vite-env.d.ts │ ├── tsconfig.json │ └── vite.config.ts ├── pnpm-lock.yaml ├── pnpm-workspace.yaml ├── settings.gradle ├── src └── main │ ├── java │ └── run │ │ └── halo │ │ └── search │ │ └── widget │ │ ├── SearchView.java │ │ ├── SearchWidgetHeadProcessor.java │ │ └── SearchWidgetPlugin.java │ └── resources │ ├── extensions │ └── reverseProxy.yaml │ ├── logo.svg │ └── plugin.yaml └── tsconfig.json /.github/workflows/cd.yaml: -------------------------------------------------------------------------------- 1 | name: CD 2 | 3 | on: 4 | release: 5 | types: 6 | - published 7 | 8 | jobs: 9 | cd: 10 | uses: halo-sigs/reusable-workflows/.github/workflows/plugin-cd.yaml@v3 11 | secrets: 12 | halo-pat: ${{ secrets.HALO_PAT }} 13 | permissions: 14 | contents: write 15 | with: 16 | node-version: "20" 17 | pnpm-version: "9" 18 | app-id: app-DlacW 19 | ui-path: "." 20 | -------------------------------------------------------------------------------- /.github/workflows/ci.yaml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | branches: 9 | - main 10 | 11 | jobs: 12 | ci: 13 | uses: halo-sigs/reusable-workflows/.github/workflows/plugin-ci.yaml@v1 14 | with: 15 | node-version: "20" 16 | pnpm-version: "9" 17 | ui-path: "." 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Maven 2 | target/ 3 | logs/ 4 | !.mvn/wrapper/maven-wrapper.jar 5 | 6 | ### Gradle 7 | .gradle 8 | /build/ 9 | /out/ 10 | !gradle/wrapper/gradle-wrapper.jar 11 | bin/ 12 | 13 | ### STS ### 14 | .apt_generated 15 | .classpath 16 | .factorypath 17 | .project 18 | .settings 19 | .springBeans 20 | .sts4-cache 21 | 22 | ### IntelliJ IDEA ### 23 | .idea 24 | *.iws 25 | *.iml 26 | *.ipr 27 | log/ 28 | 29 | ### NetBeans ### 30 | nbproject/private/ 31 | build/ 32 | nbbuild/ 33 | dist/ 34 | nbdist/ 35 | .nb-gradle/ 36 | 37 | ### Mac 38 | .DS_Store 39 | */.DS_Store 40 | 41 | ### VS Code ### 42 | *.project 43 | *.factorypath 44 | 45 | ### Compiled class file 46 | *.class 47 | 48 | ### Log file 49 | *.log 50 | 51 | ### BlueJ files 52 | *.ctxt 53 | 54 | ### Mobile Tools for Java (J2ME) 55 | .mtj.tmp/ 56 | 57 | ### Package Files 58 | *.war 59 | *.nar 60 | *.ear 61 | *.zip 62 | *.tar.gz 63 | *.rar 64 | 65 | ### VSCode 66 | .vscode 67 | 68 | ### Local file 69 | application-local.yml 70 | application-local.yaml 71 | application-local.properties 72 | 73 | /packages/*/node_modules/ 74 | node_modules 75 | /workplace/ 76 | /src/main/resources/static -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /OWNERS: -------------------------------------------------------------------------------- 1 | reviewers: 2 | - ruibaby 3 | - guqing 4 | - JohnNiang 5 | - wangzhen-fit2cloud 6 | 7 | approvers: 8 | - ruibaby 9 | - guqing 10 | - JohnNiang 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # plugin-search-widget 2 | 3 | Halo 2.0 的通用搜索组件插件。 4 | 5 | ![Preview](./images/preview.png) 6 | 7 | ## 使用方式 8 | 9 | 1. 下载，目前提供以下两个下载方式： 10 | - GitHub Releases：访问 [Releases](https://github.com/halo-dev/plugin-search-widget/releases) 下载 Assets 中的 JAR 文件。 11 | - Halo 应用市场：。 12 | 2. 安装，插件安装和更新方式可参考：。 13 | 14 | > 需要注意的是，此插件需要主题进行适配，不会主动显示搜索入口。 15 | 16 | ## 开发环境 17 | 18 | ```bash 19 | git clone git@github.com:halo-dev/plugin-search-widget.git 20 | 21 | # 或者当你 fork 之后 22 | 23 | git clone git@github.com:{your_github_id}/plugin-search-widget.git 24 | ``` 25 | 26 | ```bash 27 | cd path/to/plugin-search-widget 28 | ``` 29 | 30 | ```bash 31 | ./gradlew pnpmInstall 32 | 33 | ./gradlew build 34 | ``` 35 | 36 | 修改 Halo 配置文件： 37 | 38 | ```yaml 39 | halo: 40 | plugin: 41 | runtime-mode: development 42 | classes-directories: 43 | - "build/classes" 44 | - "build/resources" 45 | lib-directories: 46 | - "libs" 47 | fixedPluginPath: 48 | - "/path/to/plugin-search-widget" 49 | ``` 50 | 51 | ## 主题适配 52 | 53 | ### 调用搜索弹框 54 | 55 | 此插件是一个通用的搜索框插件，主题需要做的只是通过 JS API 唤起搜索框即可，以下是代码示例： 56 | 57 | ```html 58 |
  • 59 | 60 | 搜索 61 | 62 |
    • 63 | ``` 64 | 65 | 其中，`pluginFinder.available('PluginSearchWidget')` 的作用是判断使用者是否安装和启用了此插件，如果没有安装或者没有启用，那么就不会显示搜索入口。 66 | 67 | ### 自定义样式 68 | 69 | 虽然目前不能直接为搜索组件编写额外的样式，但可以通过一系列的 CSS 变量来自定义部分样式，开发者可以根据需求自行在主题中添加这些 CSS 变量，让搜索组件和主题更好地融合。 70 | 71 | 目前已提供的 CSS 变量： 72 | 73 | | 变量名 | 描述 | 备注 | 74 | |-----------------------------------------------------|------------------|----------------------------------------------------------------------------------| 75 | | `--halo-search-widget-base-font-size` | 基础字体大小 | -- | 76 | | `--halo-search-widget-base-font-family` | 字体 | -- | 77 | | `--halo-search-widget-base-rounded` | 边框圆角 | -- | 78 | | `--halo-search-widget-base-bg-color` | 基础背景色 | -- | 79 | | `--halo-search-widget-primary-color` | 主色 | -- | 80 | | `--halo-search-widget-muted-color` | 辅助色 | -- | 81 | | `--halo-search-widget-content-color` | 文本色 | -- | 82 | | `--halo-search-widget-modal-bg-color` | 模态框背景色 | -- | 83 | | `--halo-search-widget-modal-layer-color` | 模态框遮挡层背景色 | -- | 84 | | `--halo-search-widget-hit-bg-color` | 搜索结果条目背景色 | -- | 85 | | `--halo-search-widget-divider-color` | 分割线颜色 | -- | 86 | | `--halo-search-widget-kbd-border-color` | 快捷键图标边框颜色 | -- | 87 | | `--halo-search-widget-kbd-shadow` | 快捷键图标阴影 | -- | 88 | | `--halo-search-widget-base-border-radius` | 基础元素的圆角 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-base-rounded` 代替 | 89 | | `--halo-search-widget-color-modal-layer` | 模态层颜色 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-modal-layer-color` 代替 | 90 | | `--halo-search-widget-color-modal-content-bg` | 模态内容背景颜色 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-modal-bg-color` 代替 | 91 | | `--halo-search-widget-color-form-input-bg` | 表单输入背景颜色 | 已过时，将在未来的版本移除 | 92 | | `--halo-search-widget-color-form-input` | 表单输入文字颜色 | 已过时，将在未来的版本移除 | 93 | | `--halo-search-widget-color-form-input-placeholder` | 表单输入占位符颜色 | 已过时，将在未来的版本移除 | 94 | | `--halo-search-widget-color-form-divider` | 表单分隔线颜色 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-divider-color` 代替 | 95 | | `--halo-search-widget-color-result-empty` | 无结果提示颜色 | 已过时，将在未来的版本移除 | 96 | | `--halo-search-widget-color-result-item-bg` | 结果项背景颜色 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-hit-bg-color` 代替 | 97 | | `--halo-search-widget-color-result-item-hover-bg` | 结果项悬停背景颜色 | 已过时，将在未来的版本移除 | 98 | | `--halo-search-widget-color-result-item-title` | 结果项标题颜色 | 已过时，将在未来的版本移除 | 99 | | `--halo-search-widget-color-result-item-content` | 结果项内容颜色 | 已过时，将在未来的版本移除 | 100 | | `--halo-search-widget-color-command-kbd-item` | 命令键盘项颜色 | 已过时，将在未来的版本移除 | 101 | | `--halo-search-widget-color-command-kbd-border` | 命令键盘边框颜色 | 已过时，将在未来的版本移除，后续使用 `--halo-search-widget-kbd-border-color` 代替 | 102 | 103 |
    104 | 点击查看 CSS 代码模板 105 | 106 | ```css 107 | :root{ 108 | --halo-search-widget-base-font-size: ; 109 | --halo-search-widget-base-font-family: ; 110 | --halo-search-widget-base-rounded: ; 111 | --halo-search-widget-base-bg-color: ; 112 | --halo-search-widget-primary-color: ; 113 | --halo-search-widget-muted-color: ; 114 | --halo-search-widget-content-color: ; 115 | --halo-search-widget-modal-bg-color: ; 116 | --halo-search-widget-modal-layer-color: ; 117 | --halo-search-widget-hit-bg-color: ; 118 | --halo-search-widget-divider-color: ; 119 | --halo-search-widget-kbd-border-color: ; 120 | --halo-search-widget-kbd-shadow: ; 121 | } 122 | ``` 123 | 124 |
    125 | 126 | ### 配色切换方案 127 | 128 | 根据上面提供的 CSS 变量，也可以通过定义 CSS 变量的方式为搜索组件提供动态切换配色的功能。 129 | 130 | 以下是实现示例，你可以根据需求自行修改选择器或者媒体查询。 131 | 132 | ```css 133 | @media (prefers-color-scheme: dark) { 134 | .color-scheme-auto, 135 | [data-color-scheme='auto'] { 136 | color-scheme: dark; 137 | --halo-search-widget-muted-color: #cbd5e1; 138 | --halo-search-widget-content-color: #f1f5f9; 139 | --halo-search-widget-hit-bg-color: #090a11; 140 | --halo-search-widget-modal-bg-color: #15172a; 141 | --halo-search-widget-modal-layer-color: #000000cc; 142 | --halo-search-widget-base-bg-color: #090a11; 143 | --halo-search-widget-divider-color: #1e293b; 144 | --halo-search-widget-kbd-border-color: #334155; 145 | --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a; 146 | } 147 | } 148 | 149 | .color-scheme-dark, 150 | .dark, 151 | [data-color-scheme='dark'] { 152 | color-scheme: dark; 153 | --halo-search-widget-muted-color: #cbd5e1; 154 | --halo-search-widget-content-color: #f1f5f9; 155 | --halo-search-widget-hit-bg-color: #090a11; 156 | --halo-search-widget-modal-bg-color: #15172a; 157 | --halo-search-widget-modal-layer-color: #000000cc; 158 | --halo-search-widget-base-bg-color: #090a11; 159 | --halo-search-widget-divider-color: #1e293b; 160 | --halo-search-widget-kbd-border-color: #334155; 161 | --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a; 162 | } 163 | ``` 164 | 165 | 此外，为了让主题可以更加方便的适配暗黑模式，此插件也提供了一套暗黑模式的配色方案，主题可以直接使用此方案，而不需要自己去适配暗黑模式，适配方式如下： 166 | 167 | 1. 在 html 或者 body 标签添加 class： 168 | 1. `color-scheme-auto`：自动模式，根据系统的暗黑模式自动切换。 169 | 2. `color-scheme-dark` / `dark`：强制暗黑模式。 170 | 3. `color-scheme-light` / `light`：强制明亮模式。 171 | 2. 在 html 或者 body 标签添加 `data-color-scheme` 属性： 172 | 1. `auto`：自动模式，根据系统的暗黑模式自动切换。 173 | 2. `dark`：强制暗黑模式。 174 | 3. `light`：强制明亮模式。 175 | 176 | ## Credits 177 | 178 | - [Algolia DocSearch](https://github.com/algolia/docsearch): 搜索组件的 UI 设计灵感来源于 DocSearch。 179 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java' 3 | id "io.freefair.lombok" version "8.0.1" 4 | id "com.github.node-gradle.node" version "7.0.2" 5 | id "run.halo.plugin.devtools" version "0.1.1" 6 | } 7 | 8 | group 'run.halo.search.widget' 9 | sourceCompatibility = JavaVersion.VERSION_17 10 | 11 | repositories { 12 | mavenCentral() 13 | maven { url 'https://s01.oss.sonatype.org/content/repositories/releases' } 14 | maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' } 15 | maven { url 'https://repo.spring.io/milestone' } 16 | } 17 | 18 | dependencies { 19 | implementation platform('run.halo.tools.platform:plugin:2.17.0-SNAPSHOT') 20 | compileOnly 'run.halo.app:api' 21 | 22 | testImplementation 'run.halo.app:api' 23 | testImplementation 'org.springframework.boot:spring-boot-starter-test' 24 | } 25 | 26 | test { 27 | useJUnitPlatform() 28 | } 29 | 30 | node { 31 | nodeProjectDir = file("${project.projectDir}") 32 | } 33 | 34 | tasks.register('buildFrontend', PnpmTask) { 35 | args = ['build:packages'] 36 | dependsOn('installDepsForUI') 37 | } 38 | 39 | tasks.register('installDepsForUI', PnpmTask) { 40 | args = ['install'] 41 | } 42 | 43 | build { 44 | // build frontend before build 45 | tasks.named('compileJava').configure { 46 | dependsOn('buildFrontend') 47 | } 48 | } 49 | 50 | halo { 51 | version = "2.20" 52 | } 53 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | version=1.0.0-SNAPSHOT 2 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/halo-dev/plugin-search-widget/9f9f1eb3d21a1b563b3bd1a96d0ad7de08742b93/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip 4 | networkTimeout=10000 5 | zipStoreBase=GRADLE_USER_HOME 6 | zipStorePath=wrapper/dists 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 147 | # shellcheck disable=SC3045 148 | MAX_FD=$( ulimit -H -n ) || 149 | warn "Could not query maximum file descriptor limit" 150 | esac 151 | case $MAX_FD in #( 152 | '' | soft) :;; #( 153 | *) 154 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 155 | # shellcheck disable=SC3045 156 | ulimit -n "$MAX_FD" || 157 | warn "Could not set maximum file descriptor limit to $MAX_FD" 158 | esac 159 | fi 160 | 161 | # Collect all arguments for the java command, stacking in reverse order: 162 | # * args from the command line 163 | # * the main class name 164 | # * -classpath 165 | # * -D...appname settings 166 | # * --module-path (only if needed) 167 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 168 | 169 | # For Cygwin or MSYS, switch paths to Windows format before running java 170 | if "$cygwin" || "$msys" ; then 171 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 172 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 173 | 174 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 175 | 176 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 177 | for arg do 178 | if 179 | case $arg in #( 180 | -*) false ;; # don't mess with options #( 181 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 182 | [ -e "$t" ] ;; #( 183 | *) false ;; 184 | esac 185 | then 186 | arg=$( cygpath --path --ignore --mixed "$arg" ) 187 | fi 188 | # Roll the args list around exactly as many times as the number of 189 | # args, so each arg winds up back in the position where it started, but 190 | # possibly modified. 191 | # 192 | # NB: a `for` loop captures its iteration list before it begins, so 193 | # changing the positional parameters here affects neither the number of 194 | # iterations, nor the values presented in `arg`. 195 | shift # remove old arg 196 | set -- "$@" "$arg" # push replacement arg 197 | done 198 | fi 199 | 200 | # Collect all arguments for the java command; 201 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 202 | # shell script including quotes and variable substitutions, so put them in 203 | # double quotes to make sure that they get re-expanded; and 204 | # * put everything else in single quotes, so that it's not re-expanded. 205 | 206 | set -- \ 207 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 208 | -classpath "$CLASSPATH" \ 209 | org.gradle.wrapper.GradleWrapperMain \ 210 | "$@" 211 | 212 | # Stop when "xargs" is not available. 213 | if ! command -v xargs >/dev/null 2>&1 214 | then 215 | die "xargs is not available" 216 | fi 217 | 218 | # Use "xargs" to parse quoted args. 219 | # 220 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 221 | # 222 | # In Bash we could simply go: 223 | # 224 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 225 | # set -- "${ARGS[@]}" "$@" 226 | # 227 | # but POSIX shell has neither arrays nor command substitution, so instead we 228 | # post-process each arg (as a line of input to sed) to backslash-escape any 229 | # character that might be a shell metacharacter, then use eval to reverse 230 | # that process (while maintaining the separation between arguments), and wrap 231 | # the whole thing up as a single "set" statement. 232 | # 233 | # This will of course break if any of these variables contains a newline or 234 | # an unmatched quote. 235 | # 236 | 237 | eval "set -- $( 238 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 239 | xargs -n1 | 240 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 241 | tr '\n' ' ' 242 | )" '"$@"' 243 | 244 | exec "$JAVACMD" "$@" 245 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /images/preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/halo-dev/plugin-search-widget/9f9f1eb3d21a1b563b3bd1a96d0ad7de08742b93/images/preview.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "license": "GPL-3.0", 3 | "author": { 4 | "name": "Halo OSS Team", 5 | "url": "https://github.com/halo-dev" 6 | }, 7 | "contributors": [ 8 | { 9 | "name": "Ryan Wang", 10 | "email": "i@ryanc.cc", 11 | "url": "https://github.com/ruibaby" 12 | } 13 | ], 14 | "scripts": { 15 | "build:packages": "pnpm --filter \"./packages/**\" build", 16 | "example:dev": "pnpm --filter \"./packages/search-widget\" dev", 17 | "release:packages": "pnpm --filter \"./packages/**\" release" 18 | }, 19 | "devDependencies": { 20 | "@halo-dev/api-client": "2.17.0", 21 | "@rushstack/eslint-patch": "^1.10.4", 22 | "@types/node": "^18.19.43", 23 | "@typescript-eslint/eslint-plugin": "^6.21.0", 24 | "@typescript-eslint/parser": "^6.21.0", 25 | "eslint": "^8.57.0", 26 | "prettier": "^2.8.8", 27 | "typescript": "^5.5.4", 28 | "vite": "^5.3.5" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /packages/search-widget/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "extends": [ 4 | "eslint:recommended", 5 | "plugin:@typescript-eslint/eslint-recommended", 6 | "plugin:@typescript-eslint/recommended", 7 | "@unocss" 8 | ], 9 | "parser": "@typescript-eslint/parser", 10 | "parserOptions": { 11 | "ecmaVersion": 2020, 12 | "sourceType": "module" 13 | }, 14 | "plugins": ["@typescript-eslint"], 15 | "env": { 16 | "browser": true 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /packages/search-widget/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | .DS_Store 12 | dist 13 | dist-ssr 14 | coverage 15 | *.local 16 | 17 | /cypress/videos/ 18 | /cypress/screenshots/ 19 | 20 | # Editor directories and files 21 | .vscode/* 22 | !.vscode/extensions.json 23 | .idea 24 | *.suo 25 | *.ntvs* 26 | *.njsproj 27 | *.sln 28 | *.sw? 29 | -------------------------------------------------------------------------------- /packages/search-widget/.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "es5", 3 | "tabWidth": 2, 4 | "singleQuote": true, 5 | "bracketSpacing": true, 6 | "arrowParens": "always" 7 | } 8 | -------------------------------------------------------------------------------- /packages/search-widget/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Search Widget Preview 7 | 8 | 9 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 66 | 67 | -------------------------------------------------------------------------------- /packages/search-widget/lit-localize.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://raw.githubusercontent.com/lit/lit/main/packages/localize-tools/config.schema.json", 3 | "sourceLocale": "en", 4 | "targetLocales": [ 5 | "es", 6 | "zh-CN", 7 | "zh-TW" 8 | ], 9 | "tsConfig": "./tsconfig.json", 10 | "output": { 11 | "mode": "runtime", 12 | "outputDir": "./src/generated/locales", 13 | "localeCodesModule": "./src/generated/locale-codes.ts" 14 | }, 15 | "interchange": { 16 | "format": "xliff", 17 | "xliffDir": "./xliff/" 18 | } 19 | } -------------------------------------------------------------------------------- /packages/search-widget/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@halo-dev/search-widget", 3 | "version": "1.0.0", 4 | "type": "module", 5 | "exports": { 6 | ".": { 7 | "types": "./dist/index.d.ts", 8 | "import": "./dist/index.js" 9 | }, 10 | "./var.css": "./var.css" 11 | }, 12 | "main": "./dist/index.js", 13 | "module": "./dist/index.js", 14 | "types": "./dist/index.d.ts", 15 | "files": [ 16 | "dist", 17 | "var.css" 18 | ], 19 | "scripts": { 20 | "dev": "vite --config vite.config.dev.ts", 21 | "build": "vite build --config vite.config.lib.ts", 22 | "lint": "lit-analyzer && eslint 'src/**/*.ts' --fix", 23 | "prettier": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.gitignore --write" 24 | }, 25 | "dependencies": { 26 | "@lit/localize": "^0.12.2", 27 | "lit": "^3.2.0", 28 | "lodash-es": "^4.17.21", 29 | "overlayscrollbars": "^2.10.0" 30 | }, 31 | "devDependencies": { 32 | "@iconify/json": "^2.2.234", 33 | "@julr/unocss-preset-forms": "^0.1.0", 34 | "@lit/localize-tools": "^0.8.0", 35 | "@types/lodash-es": "^4.17.12", 36 | "@unocss/eslint-config": "^0.61.9", 37 | "@unocss/reset": "^0.61.9", 38 | "lit-analyzer": "^1.2.1", 39 | "unocss": "^0.61.9", 40 | "vite-plugin-dts": "4.0.0-beta.2" 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /packages/search-widget/src/constants/index.ts: -------------------------------------------------------------------------------- 1 | export const HISTORY_KEY = 'halo:search-widgets:history:hits'; 2 | export const MAX_HISTORY_ITEMS = 50; -------------------------------------------------------------------------------- /packages/search-widget/src/generated/locale-codes.ts: -------------------------------------------------------------------------------- 1 | // Do not modify this file by hand! 2 | // Re-generate this file by running lit-localize. 3 | 4 | /** 5 | * The locale code that templates in this source code are written in. 6 | */ 7 | export const sourceLocale = `en`; 8 | 9 | /** 10 | * The other locale codes that this application is localized into. Sorted 11 | * lexicographically. 12 | */ 13 | export const targetLocales = [ 14 | `es`, 15 | `zh-CN`, 16 | `zh-TW`, 17 | ] as const; 18 | 19 | /** 20 | * All valid project locale codes. Sorted lexicographically. 21 | */ 22 | export const allLocales = [ 23 | `en`, 24 | `es`, 25 | `zh-CN`, 26 | `zh-TW`, 27 | ] as const; 28 | -------------------------------------------------------------------------------- /packages/search-widget/src/generated/locales/es.ts: -------------------------------------------------------------------------------- 1 | 2 | // Do not modify this file by hand! 3 | // Re-generate this file by running lit-localize 4 | 5 | 6 | 7 | 8 | /* eslint-disable no-irregular-whitespace */ 9 | /* eslint-disable @typescript-eslint/no-explicit-any */ 10 | 11 | export const templates = { 12 | 's5e8250fb85d64c23': `Cerrar`, 13 | 'sa84142fc34654130': `Sin resultados de búsqueda`, 14 | 'sad5f82f8364e5a1c': `Introducir palabras clave para buscar`, 15 | 'sb4f1dffbb6be6302': `Borrar`, 16 | 'sb85774dc5d18ff0f': `Confirmar`, 17 | 'sbce70cbdb856635e': `Recientes`, 18 | 'sfc63e31ac7c956ed': `Seleccionar`, 19 | }; 20 | -------------------------------------------------------------------------------- /packages/search-widget/src/generated/locales/zh-CN.ts: -------------------------------------------------------------------------------- 1 | 2 | // Do not modify this file by hand! 3 | // Re-generate this file by running lit-localize 4 | 5 | 6 | 7 | 8 | /* eslint-disable no-irregular-whitespace */ 9 | /* eslint-disable @typescript-eslint/no-explicit-any */ 10 | 11 | export const templates = { 12 | 's5e8250fb85d64c23': `关闭`, 13 | 'sa84142fc34654130': `没有搜索结果`, 14 | 'sad5f82f8364e5a1c': `输入关键词以搜索`, 15 | 'sb4f1dffbb6be6302': `清空`, 16 | 'sb85774dc5d18ff0f': `确认`, 17 | 'sbce70cbdb856635e': `最近搜索`, 18 | 'sfc63e31ac7c956ed': `选择`, 19 | }; 20 | -------------------------------------------------------------------------------- /packages/search-widget/src/generated/locales/zh-TW.ts: -------------------------------------------------------------------------------- 1 | 2 | // Do not modify this file by hand! 3 | // Re-generate this file by running lit-localize 4 | 5 | 6 | 7 | 8 | /* eslint-disable no-irregular-whitespace */ 9 | /* eslint-disable @typescript-eslint/no-explicit-any */ 10 | 11 | export const templates = { 12 | 's5e8250fb85d64c23': `關閉`, 13 | 'sa84142fc34654130': `沒有搜尋結果`, 14 | 'sad5f82f8364e5a1c': `輸入關鍵字以搜尋`, 15 | 'sb4f1dffbb6be6302': `清空`, 16 | 'sb85774dc5d18ff0f': `確認`, 17 | 'sbce70cbdb856635e': `最近搜尋`, 18 | 'sfc63e31ac7c956ed': `選擇`, 19 | }; 20 | -------------------------------------------------------------------------------- /packages/search-widget/src/index.ts: -------------------------------------------------------------------------------- 1 | import { SearchForm } from './search-form'; 2 | import { SearchModal } from './search-modal'; 3 | import './locale'; 4 | 5 | export { SearchForm, SearchModal }; 6 | -------------------------------------------------------------------------------- /packages/search-widget/src/locale/index.ts: -------------------------------------------------------------------------------- 1 | import { configureLocalization, LocaleModule } from '@lit/localize'; 2 | import * as templates_es from '../generated/locales/es'; 3 | import * as templates_zh_CN from '../generated/locales/zh-CN'; 4 | import * as templates_zh_TW from '../generated/locales/zh-TW'; 5 | import { allLocales, sourceLocale, targetLocales } from '../generated/locale-codes'; 6 | 7 | const localizedTemplates = new Map([ 8 | ['es', templates_es], 9 | ['zh-CN', templates_zh_CN], 10 | ['zh-TW', templates_zh_TW], 11 | ]); 12 | 13 | const { setLocale } = configureLocalization({ 14 | sourceLocale, 15 | targetLocales, 16 | loadLocale: async (locale) => localizedTemplates.get(locale) as LocaleModule, 17 | }); 18 | 19 | setLocale(getLocale()); 20 | 21 | function getLanguageFromCookie() { 22 | const match = document.cookie.match(new RegExp('(^| )language=([^;]+)')); 23 | const matchedLanguage = allLocales.find((locale) => locale === match?.[2]); 24 | return matchedLanguage; 25 | } 26 | 27 | function getLanguageFromBrowser() { 28 | const language = allLocales.find((locale) => locale === navigator.language); 29 | return language; 30 | } 31 | 32 | export function getLocale() { 33 | return getLanguageFromCookie() || getLanguageFromBrowser() || sourceLocale; 34 | } 35 | -------------------------------------------------------------------------------- /packages/search-widget/src/search-form.ts: -------------------------------------------------------------------------------- 1 | import { HaloDocument, SearchOption, SearchResult } from '@halo-dev/api-client'; 2 | import resetStyles from '@unocss/reset/tailwind.css?inline'; 3 | import { LitElement, css, html, unsafeCSS } from 'lit'; 4 | import { customElement, property, state } from 'lit/decorators.js'; 5 | import { Ref, createRef, ref } from 'lit/directives/ref.js'; 6 | import { unsafeHTML } from 'lit/directives/unsafe-html.js'; 7 | import { DebouncedFunc, debounce, uniqBy } from 'lodash-es'; 8 | import { HISTORY_KEY, MAX_HISTORY_ITEMS } from './constants'; 9 | import baseStyles from './styles/base'; 10 | import { msg } from '@lit/localize'; 11 | 12 | @customElement('search-form') 13 | export class SearchForm extends LitElement { 14 | @property({ type: String }) 15 | baseUrl = ''; 16 | 17 | @property({ type: Object }) 18 | options = {}; 19 | 20 | @state() 21 | private keyword = ''; 22 | 23 | @state() 24 | private searchResult?: SearchResult; 25 | 26 | @state() 27 | private loading: boolean = false; 28 | 29 | @state() 30 | private selectedIndex = 0; 31 | 32 | @state() 33 | private historyHits: HaloDocument[] = []; 34 | 35 | inputRef: Ref = createRef(); 36 | 37 | constructor() { 38 | super(); 39 | 40 | this.addEventListener('keydown', this.handleKeydown); 41 | 42 | this.historyHits = JSON.parse( 43 | localStorage.getItem(HISTORY_KEY) || '[]' 44 | ) as HaloDocument[]; 45 | 46 | setTimeout(() => { 47 | this.inputRef.value?.focus(); 48 | }, 0); 49 | } 50 | 51 | override render() { 52 | return html` 53 |
    54 |
    e.preventDefault()} 57 | > 58 | 63 | 71 | ${this.keyword 72 | ? html` 73 | 77 | ` 78 | : ''} 79 |
    80 |
    81 | 82 | ${this.keyword ? this.renderItems() : this.renderHistoryItems()} 83 | 84 |
    87 | ${[ 88 | { 89 | text: html`${msg('Select')}`, 90 | kbdIcons: ['i-lucide-arrow-up', 'i-lucide-arrow-down'], 91 | }, 92 | { 93 | text: html`${msg('Confirm')}`, 94 | kbdIcons: ['i-lucide-corner-down-left'], 95 | }, 96 | { 97 | text: html`${msg('Close')}`, 98 | kbdIcons: ['i-mdi-keyboard-esc'], 99 | }, 100 | ].map( 101 | (item) => html` 102 |
    103 | ${item.kbdIcons.map( 104 | (icon) => html` 105 | 108 | 109 | 110 | ` 111 | )} 112 | ${item.text} 113 |
    114 | ` 115 | )} 116 |
    117 | `; 118 | } 119 | 120 | handleClearInput() { 121 | this.keyword = ''; 122 | this.searchResult = undefined; 123 | this.inputRef.value!.value = ''; 124 | this.inputRef.value!.focus(); 125 | } 126 | 127 | renderItems() { 128 | return html`
    129 | ${!this.searchResult?.hits?.length ? this.renderEmpty() : ''} 130 |
      131 | ${this.searchResult?.hits?.map((hit, index) => 132 | this.renderListItem(hit, index, 'i-lucide-file-text') 133 | )} 134 |
    135 |
    `; 136 | } 137 | 138 | renderEmpty() { 139 | return html`
    140 | ${msg('No search results')} 141 |
    `; 142 | } 143 | 144 | renderHistoryItems() { 145 | return html` 146 |
    147 | ${this.historyHits.length 148 | ? html`
    149 |

    150 | ${msg('Recent')} 151 |

    152 | 156 | ${msg('Clear')} 157 | 158 |
    159 |
      160 | ${this.historyHits?.map((hit, index) => 161 | this.renderListItem(hit, index, 'i-lucide-history') 162 | )} 163 |
    ` 164 | : this.renderEmpty()} 165 |
    166 | `; 167 | } 168 | 169 | renderListItem(hit: HaloDocument, index: number, listIcon: string) { 170 | return html` 171 |
  • (this.selectedIndex = index)} 174 | class="shadow-sm flex items-center space-x-3 rounded-base cursor-pointer p-3 bg-hit [&_mark]:text-primary [&_mark]:font-semibold [&_mark]:bg-transparent ${index === 175 | this.selectedIndex 176 | ? '!bg-primary [&_mark]:!text-white [&_mark]:underline' 177 | : ''}" 178 | data-index=${index} 179 | > 180 | 185 |
    186 |

    191 | ${unsafeHTML(hit.title)} 192 |

    193 | ${hit.description 194 | ? html` 195 |

    200 | ${unsafeHTML(hit.description)} 201 |

    202 | ` 203 | : ''} 204 |
    205 | 211 |
    • 212 | `; 213 | } 214 | 215 | onInput(e: InputEvent) { 216 | const input = e.target as HTMLInputElement; 217 | const value = input.value; 218 | 219 | this.keyword = value || ''; 220 | 221 | this.selectedIndex = 0; 222 | 223 | if (value === '') { 224 | this.searchResult = undefined; 225 | return; 226 | } 227 | 228 | this.loading = true; 229 | this.fetchHits(value); 230 | } 231 | 232 | handleClearHistory() { 233 | localStorage.removeItem(HISTORY_KEY); 234 | this.historyHits = []; 235 | } 236 | 237 | fetchHits: DebouncedFunc<(keyword: string) => Promise> = debounce( 238 | async (keyword: string) => { 239 | const searchOptions: SearchOption = { 240 | ...this.options, 241 | highlightPostTag: '', 242 | highlightPreTag: '', 243 | keyword, 244 | limit: 20, 245 | }; 246 | 247 | const response = await fetch( 248 | `/apis/api.halo.run/v1alpha1/indices/-/search`, 249 | { 250 | headers: { 251 | 'Content-Type': 'application/json', 252 | }, 253 | body: JSON.stringify(searchOptions), 254 | method: 'post', 255 | } 256 | ); 257 | 258 | const data = (await response.json()) as SearchResult; 259 | this.searchResult = data; 260 | this.loading = false; 261 | }, 262 | 300 263 | ); 264 | 265 | handleOpenLink(hit: HaloDocument) { 266 | const updatedHistory = uniqBy([hit, ...this.historyHits], 'id').slice( 267 | 0, 268 | MAX_HISTORY_ITEMS 269 | ); 270 | localStorage.setItem(HISTORY_KEY, JSON.stringify(updatedHistory)); 271 | this.historyHits = updatedHistory; 272 | window.location.href = hit.permalink; 273 | } 274 | 275 | handleKeydown = (e: KeyboardEvent) => { 276 | const { key, ctrlKey } = e; 277 | 278 | const hits = this.keyword ? this.searchResult?.hits : this.historyHits; 279 | 280 | if (!hits) { 281 | return; 282 | } 283 | 284 | if (key === 'ArrowUp' || (key === 'k' && ctrlKey)) { 285 | this.selectedIndex = Math.max(0, this.selectedIndex - 1); 286 | this.handleScrollIntoSelected(); 287 | e.preventDefault(); 288 | } 289 | 290 | if (key === 'ArrowDown' || (key === 'j' && ctrlKey)) { 291 | this.selectedIndex = Math.min(hits.length || 0, this.selectedIndex + 1); 292 | this.handleScrollIntoSelected(); 293 | e.preventDefault(); 294 | } 295 | 296 | if (key === 'Enter') { 297 | const hit = hits[this.selectedIndex]; 298 | if (hit) { 299 | this.handleOpenLink(hit); 300 | } 301 | } 302 | }; 303 | 304 | handleScrollIntoSelected() { 305 | const selectedElement = this.shadowRoot?.querySelector( 306 | `[data-index="${this.selectedIndex}"]` 307 | ); 308 | if (selectedElement) { 309 | selectedElement.scrollIntoView({ 310 | behavior: 'smooth', 311 | block: 'center', 312 | }); 313 | } 314 | } 315 | 316 | static override styles = [ 317 | unsafeCSS(resetStyles), 318 | baseStyles, 319 | css` 320 | @unocss-placeholder; 321 | `, 322 | ]; 323 | } 324 | 325 | declare global { 326 | interface HTMLElementTagNameMap { 327 | 'search-form': SearchForm; 328 | } 329 | } 330 | -------------------------------------------------------------------------------- /packages/search-widget/src/search-modal.ts: -------------------------------------------------------------------------------- 1 | import resetStyles from '@unocss/reset/tailwind.css?inline'; 2 | import { LitElement, PropertyValues, css, html, unsafeCSS } from 'lit'; 3 | import { customElement, property } from 'lit/decorators.js'; 4 | import { styleMap } from 'lit/directives/style-map.js'; 5 | import { OverlayScrollbars } from 'overlayscrollbars'; 6 | import overlayscrollbarsStyles from 'overlayscrollbars/styles/overlayscrollbars.css?inline'; 7 | import './search-form'; 8 | import baseStyles from './styles/base'; 9 | 10 | @customElement('search-modal') 11 | export class SearchModal extends LitElement { 12 | @property({ 13 | type: Boolean, 14 | }) 15 | open = false; 16 | 17 | @property({ type: String }) 18 | baseUrl = ''; 19 | 20 | @property({ type: Object }) 21 | options = {}; 22 | 23 | constructor() { 24 | super(); 25 | 26 | setTimeout(() => { 27 | const modalContent = this.shadowRoot?.querySelector( 28 | '.modal__content' 29 | ) as HTMLElement; 30 | if (modalContent) { 31 | OverlayScrollbars(modalContent, { 32 | scrollbars: { 33 | autoHide: 'scroll', 34 | autoHideDelay: 600, 35 | }, 36 | }); 37 | } 38 | }, 0); 39 | } 40 | 41 | override willUpdate(changedProperties: PropertyValues) { 42 | if (!changedProperties.has('open')) { 43 | return; 44 | } 45 | 46 | if (this.open) { 47 | document.body.style.overflow = 'hidden'; 48 | } else { 49 | document.body.style.removeProperty('overflow'); 50 | } 51 | } 52 | 53 | override render() { 54 | return html`
    58 |
    59 |
    63 | ${this.open 64 | ? html`` 68 | : ''} 69 |
    70 |
    `; 71 | } 72 | 73 | close() { 74 | this.open = false; 75 | } 76 | 77 | handleKeydown = (e: KeyboardEvent) => { 78 | const { key } = e; 79 | 80 | if (key === 'Escape') { 81 | this.close(); 82 | e.preventDefault(); 83 | } 84 | }; 85 | 86 | override connectedCallback() { 87 | super.connectedCallback(); 88 | window.addEventListener('keydown', this.handleKeydown); 89 | } 90 | 91 | override disconnectedCallback() { 92 | super.disconnectedCallback(); 93 | window.removeEventListener('keydown', this.handleKeydown); 94 | } 95 | 96 | static override styles = [ 97 | unsafeCSS(resetStyles), 98 | unsafeCSS(overlayscrollbarsStyles), 99 | baseStyles, 100 | css` 101 | :host { 102 | // @deprecated --halo-search-widget-color-modal-layer and 103 | // --halo-search-widget-base-border-radius will be removed in future 104 | --base-rounded: var( 105 | --halo-search-widget-base-rounded, 106 | var(--halo-search-widget-base-border-radius, 0.4em) 107 | ); 108 | --modal-layer-color: var( 109 | --halo-search-widget-modal-layer-color, 110 | var(--halo-search-widget-color-modal-layer, rgb(107 114 128 / 0.75)) 111 | ); 112 | } 113 | 114 | .modal__wrapper { 115 | position: fixed; 116 | left: 0px; 117 | top: 0px; 118 | display: flex; 119 | height: 100%; 120 | width: 100%; 121 | flex-direction: row; 122 | align-items: flex-start; 123 | justify-content: center; 124 | padding-top: 3em; 125 | padding-bottom: 3em; 126 | z-index: 999; 127 | } 128 | 129 | .modal__layer { 130 | background-color: var(--modal-layer-color, rgb(107 114 128 / 0.75)); 131 | position: absolute; 132 | top: 0px; 133 | left: 0px; 134 | height: 100%; 135 | width: 100%; 136 | flex: none; 137 | animation: fadeIn 0.15s both; 138 | } 139 | 140 | .modal__content { 141 | border-radius: var(--base-rounded, 0.4em); 142 | position: relative; 143 | display: flex; 144 | flex-direction: column; 145 | align-items: stretch; 146 | width: calc(100vw - 20px); 147 | max-height: calc(100vh - 5em); 148 | max-width: 580px; 149 | overflow: auto; 150 | animation: fadeInUp 0.3s both; 151 | } 152 | 153 | @keyframes fadeIn { 154 | from { 155 | opacity: 0; 156 | } 157 | 158 | to { 159 | opacity: 1; 160 | } 161 | } 162 | 163 | @keyframes fadeInUp { 164 | from { 165 | opacity: 0; 166 | transform: translate3d(0, 10%, 0); 167 | } 168 | 169 | to { 170 | opacity: 1; 171 | transform: translate3d(0, 0, 0); 172 | } 173 | } 174 | 175 | @unocss-placeholder; 176 | `, 177 | ]; 178 | } 179 | 180 | declare global { 181 | interface HTMLElementTagNameMap { 182 | 'search-modal': SearchModal; 183 | } 184 | } 185 | -------------------------------------------------------------------------------- /packages/search-widget/src/styles/base.ts: -------------------------------------------------------------------------------- 1 | import { css } from 'lit'; 2 | 3 | const baseStyles = css` 4 | :host { 5 | font-size: var(--halo-search-widget-base-font-size, 1em); 6 | font-family: var( 7 | --halo-search-widget-base-font-family, 8 | ui-sans-serif, 9 | system-ui, 10 | sans-serif, 11 | 'Apple Color Emoji', 12 | 'Segoe UI Emoji', 13 | 'Segoe UI Symbol', 14 | 'Noto Color Emoji' 15 | ); 16 | } 17 | `; 18 | 19 | export default baseStyles; 20 | -------------------------------------------------------------------------------- /packages/search-widget/src/styles/var.ts: -------------------------------------------------------------------------------- 1 | import { css } from 'lit'; 2 | 3 | const varStyles = css` 4 | :host { 5 | --color-form-input-bg: var(--halo-search-widget-color-form-input-bg, #fff); 6 | --color-form-input: var(--halo-search-widget-color-form-input, #333); 7 | --color-form-input-placeholder: var( 8 | --halo-search-widget-color-form-input-placeholder, 9 | rgb(107 114 128) 10 | ); 11 | --color-form-divider: var( 12 | --halo-search-widget-color-form-divider, 13 | rgb(243 244 246) 14 | ); 15 | --color-result-empty: var( 16 | --halo-search-widget-color-result-empty, 17 | rgb(107 114 128) 18 | ); 19 | --color-result-item-bg: var( 20 | --halo-search-widget-color-result-item-bg, 21 | rgb(249 250 251) 22 | ); 23 | --color-result-item-hover-bg: var( 24 | --halo-search-widget-color-result-item-hover-bg, 25 | rgb(243 244 246) 26 | ); 27 | --color-result-item-title: var( 28 | --halo-search-widget-color-result-item-title, 29 | #333 30 | ); 31 | --color-result-item-content: var( 32 | --halo-search-widget-color-result-item-content, 33 | rgb(75, 85, 99) 34 | ); 35 | --color-command-kbd-item: var( 36 | --halo-search-widget-color-command-kbd-item, 37 | #333 38 | ); 39 | --color-command-kbd-border: var( 40 | --halo-search-widget-color-command-kbd-border, 41 | #e5e7eb 42 | ); 43 | } 44 | `; 45 | 46 | export default varStyles; 47 | -------------------------------------------------------------------------------- /packages/search-widget/src/type.d.ts: -------------------------------------------------------------------------------- 1 | export interface Hit { 2 | name: string; 3 | title: string; 4 | content: string; 5 | publishTimestamp: string; 6 | permalink: string; 7 | } 8 | 9 | export interface Result { 10 | hits: Hit[]; 11 | keyword: string; 12 | total: number; 13 | limit: number; 14 | processingTimeMills: number; 15 | } 16 | -------------------------------------------------------------------------------- /packages/search-widget/src/vite-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /packages/search-widget/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "es2021", 4 | "module": "es2020", 5 | "lib": ["es2021", "DOM", "DOM.Iterable"], 6 | "declaration": true, 7 | "declarationMap": true, 8 | "sourceMap": true, 9 | "inlineSources": true, 10 | "outDir": "./dist", 11 | "rootDir": "./src", 12 | "strict": true, 13 | "noUnusedLocals": true, 14 | "noUnusedParameters": true, 15 | "noImplicitReturns": true, 16 | "noFallthroughCasesInSwitch": true, 17 | "noImplicitAny": true, 18 | "noImplicitThis": true, 19 | "moduleResolution": "node", 20 | "allowSyntheticDefaultImports": true, 21 | "experimentalDecorators": true, 22 | "forceConsistentCasingInFileNames": true, 23 | "noImplicitOverride": true, 24 | "plugins": [ 25 | { 26 | "name": "ts-lit-plugin", 27 | "strict": true 28 | } 29 | ] 30 | }, 31 | "include": ["src/**/*.ts"], 32 | "exclude": [] 33 | } 34 | -------------------------------------------------------------------------------- /packages/search-widget/uno.config.ts: -------------------------------------------------------------------------------- 1 | import { 2 | defineConfig, 3 | definePreset, 4 | presetIcons, 5 | presetUno, 6 | transformerCompileClass, 7 | transformerDirectives, 8 | } from 'unocss'; 9 | 10 | const remRE = /(-?[.\d]+)rem/g; 11 | 12 | const presetRemToEm = definePreset(() => { 13 | return { 14 | name: '@unocss/preset-rem-to-em', 15 | postprocess: (util) => { 16 | util.entries.forEach((i) => { 17 | const value = i[1]; 18 | if (typeof value === 'string' && remRE.test(value)) 19 | i[1] = value.replace(remRE, (_, p1) => `${p1}em`); 20 | }); 21 | }, 22 | }; 23 | }); 24 | 25 | export default defineConfig({ 26 | presets: [presetUno(), presetIcons(), presetRemToEm()], 27 | transformers: [transformerDirectives(), transformerCompileClass()], 28 | theme: { 29 | colors: { 30 | primary: 'var(--halo-search-widget-primary-color,#4CCBA0)', 31 | muted: 'var(--halo-search-widget-muted-color,#475569)', 32 | content: 33 | 'var(--halo-search-widget-content-color,var(--halo-search-widget-color-form-input,#0f172a))', 34 | }, 35 | borderRadius: { 36 | base: 'var(--halo-search-widget-base-rounded, 0.4em)', 37 | }, 38 | }, 39 | shortcuts: { 40 | 'bg-modal': 41 | 'bg-[var(--halo-search-widget-modal-bg-color,var(--halo-search-widget-color-modal-content-bg,#f8fafc))]', 42 | 'bg-hit': 43 | 'bg-[var(--halo-search-widget-hit-bg-color,var(--halo-search-widget-color-result-item-bg,#fff))]', 44 | 'bg-base': 45 | 'bg-[var(--halo-search-widget-base-bg-color,var(--halo-search-widget-color-modal-content-bg,#fff))]', 46 | 'border-divider': 47 | 'border-[var(--halo-search-widget-divider-color,var(--halo-search-widget-color-form-divider,#f1f5f9))]', 48 | 'border-kbd': 49 | 'border-[var(--halo-search-widget-kbd-border-color,var(--halo-search-widget-color-command-kbd-border,#e2e8f0))]', 50 | 'shadow-kbd': 51 | 'shadow-[var(--halo-search-widget-kbd-shadow,0px_2px_0px_0px_rgba(0,0,0,0.08))]', 52 | }, 53 | safelist: [ 54 | 'i-lucide-arrow-up', 55 | 'i-lucide-arrow-down', 56 | 'i-mdi-keyboard-esc', 57 | 'i-lucide-corner-down-left', 58 | 'i-lucide-file-text', 59 | 'i-lucide-history', 60 | 'i-lucide-loader-circle', 61 | 'i-lucide-search', 62 | ], 63 | }); 64 | -------------------------------------------------------------------------------- /packages/search-widget/var.css: -------------------------------------------------------------------------------- 1 | @media (prefers-color-scheme: dark) { 2 | .color-scheme-auto, 3 | [data-color-scheme='auto'] { 4 | color-scheme: dark; 5 | --halo-search-widget-muted-color: #cbd5e1; 6 | --halo-search-widget-content-color: #f1f5f9; 7 | --halo-search-widget-hit-bg-color: #090a11; 8 | --halo-search-widget-modal-bg-color: #15172a; 9 | --halo-search-widget-modal-layer-color: #000000cc; 10 | --halo-search-widget-base-bg-color: #090a11; 11 | --halo-search-widget-divider-color: #1e293b; 12 | --halo-search-widget-kbd-border-color: #334155; 13 | --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a; 14 | } 15 | } 16 | 17 | .color-scheme-dark, 18 | .dark, 19 | [data-color-scheme='dark'] { 20 | color-scheme: dark; 21 | --halo-search-widget-muted-color: #cbd5e1; 22 | --halo-search-widget-content-color: #f1f5f9; 23 | --halo-search-widget-hit-bg-color: #090a11; 24 | --halo-search-widget-modal-bg-color: #15172a; 25 | --halo-search-widget-modal-layer-color: #000000cc; 26 | --halo-search-widget-base-bg-color: #090a11; 27 | --halo-search-widget-divider-color: #1e293b; 28 | --halo-search-widget-kbd-border-color: #334155; 29 | --halo-search-widget-kbd-shadow: 0px 2px 0px 0px #ffffff1a; 30 | } 31 | -------------------------------------------------------------------------------- /packages/search-widget/vite.config.dev.ts: -------------------------------------------------------------------------------- 1 | import UnoCSS from 'unocss/vite'; 2 | import { defineConfig, Plugin } from 'vite'; 3 | 4 | export default defineConfig({ 5 | plugins: [ 6 | UnoCSS({ 7 | mode: 'shadow-dom', 8 | configFile: './uno.config.ts', 9 | }) as Plugin, 10 | ], 11 | server: { 12 | proxy: { 13 | '/apis': { 14 | target: 'http://localhost:8090', 15 | changeOrigin: true, 16 | }, 17 | }, 18 | }, 19 | }); 20 | -------------------------------------------------------------------------------- /packages/search-widget/vite.config.lib.ts: -------------------------------------------------------------------------------- 1 | import UnoCSS from 'unocss/vite'; 2 | import { defineConfig, Plugin } from 'vite'; 3 | import dts from 'vite-plugin-dts'; 4 | 5 | export default defineConfig({ 6 | build: { 7 | lib: { 8 | entry: 'src/index.ts', 9 | name: 'search-widget', 10 | fileName: 'index', 11 | formats: ['es'], 12 | }, 13 | emptyOutDir: true, 14 | rollupOptions: { 15 | output: { 16 | extend: true, 17 | }, 18 | }, 19 | }, 20 | plugins: [ 21 | UnoCSS({ 22 | mode: 'shadow-dom', 23 | configFile: './uno.config.ts', 24 | }) as Plugin, 25 | dts() as Plugin, 26 | ], 27 | }); 28 | -------------------------------------------------------------------------------- /packages/search-widget/xliff/es.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Select 7 | Seleccionar 8 | 9 | 10 | Confirm 11 | Confirmar 12 | 13 | 14 | Close 15 | Cerrar 16 | 17 | 18 | Enter keywords to search 19 | Introducir palabras clave para buscar 20 | 21 | 22 | No search results 23 | Sin resultados de búsqueda 24 | 25 | 26 | Recent 27 | Recientes 28 | 29 | 30 | Clear 31 | Borrar 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /packages/search-widget/xliff/zh-CN.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Select 7 | 选择 8 | 9 | 10 | Confirm 11 | 确认 12 | 13 | 14 | Close 15 | 关闭 16 | 17 | 18 | Enter keywords to search 19 | 输入关键词以搜索 20 | 21 | 22 | No search results 23 | 没有搜索结果 24 | 25 | 26 | Recent 27 | 最近搜索 28 | 29 | 30 | Clear 31 | 清空 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /packages/search-widget/xliff/zh-TW.xlf: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Select 7 | 選擇 8 | 9 | 10 | Confirm 11 | 確認 12 | 13 | 14 | Close 15 | 關閉 16 | 17 | 18 | Enter keywords to search 19 | 輸入關鍵字以搜尋 20 | 21 | 22 | No search results 23 | 沒有搜尋結果 24 | 25 | 26 | Recent 27 | 最近搜尋 28 | 29 | 30 | Clear 31 | 清空 32 | 33 | 34 | 35 | 36 | -------------------------------------------------------------------------------- /packages/widget/.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "extends": [ 4 | "eslint:recommended", 5 | "plugin:@typescript-eslint/eslint-recommended", 6 | "plugin:@typescript-eslint/recommended" 7 | ], 8 | "parser": "@typescript-eslint/parser", 9 | "parserOptions": { 10 | "ecmaVersion": 2020, 11 | "sourceType": "module" 12 | }, 13 | "plugins": ["@typescript-eslint"], 14 | "env": { 15 | "browser": true 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /packages/widget/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | .DS_Store 12 | dist 13 | dist-ssr 14 | coverage 15 | *.local 16 | 17 | /cypress/videos/ 18 | /cypress/screenshots/ 19 | 20 | # Editor directories and files 21 | .vscode/* 22 | !.vscode/extensions.json 23 | .idea 24 | *.suo 25 | *.ntvs* 26 | *.njsproj 27 | *.sln 28 | *.sw? 29 | -------------------------------------------------------------------------------- /packages/widget/.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "es5", 3 | "tabWidth": 2, 4 | "singleQuote": true, 5 | "bracketSpacing": true, 6 | "arrowParens": "always" 7 | } 8 | -------------------------------------------------------------------------------- /packages/widget/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "scripts": { 3 | "build": "tsc && vite build", 4 | "dev": "vite", 5 | "lint": "eslint 'src/**/*.ts'", 6 | "prettier": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.gitignore --write" 7 | }, 8 | "dependencies": { 9 | "@halo-dev/search-widget": "workspace:*" 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /packages/widget/src/index.ts: -------------------------------------------------------------------------------- 1 | import { SearchModal } from '@halo-dev/search-widget'; 2 | import '@halo-dev/search-widget/var.css'; 3 | import type { SearchOption } from '@halo-dev/api-client'; 4 | 5 | export { SearchModal }; 6 | 7 | const searchModalElement = document.createElement( 8 | 'search-modal' 9 | ) as SearchModal; 10 | 11 | document.body.append(searchModalElement); 12 | 13 | export function open(options: SearchOption) { 14 | searchModalElement.options = options; 15 | searchModalElement.open = true; 16 | } 17 | -------------------------------------------------------------------------------- /packages/widget/src/vite-env.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | -------------------------------------------------------------------------------- /packages/widget/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "include": ["src"] 4 | } 5 | -------------------------------------------------------------------------------- /packages/widget/vite.config.ts: -------------------------------------------------------------------------------- 1 | import { fileURLToPath, URL } from 'node:url'; 2 | 3 | import { defineConfig } from 'vite'; 4 | import path from 'path'; 5 | 6 | export default defineConfig({ 7 | resolve: { 8 | alias: { 9 | '@': fileURLToPath(new URL('./src', import.meta.url)), 10 | }, 11 | }, 12 | define: { 13 | 'process.env': process.env, 14 | }, 15 | build: { 16 | outDir: fileURLToPath( 17 | new URL('../../src/main/resources/static', import.meta.url) 18 | ), 19 | emptyOutDir: true, 20 | cssCodeSplit: false, 21 | lib: { 22 | entry: path.resolve(__dirname, 'src/index.ts'), 23 | formats: ['iife'], 24 | name: 'SearchWidget', 25 | fileName: (format) => `search-widget.${format}.js`, 26 | }, 27 | sourcemap: false, 28 | }, 29 | }); 30 | -------------------------------------------------------------------------------- /pnpm-workspace.yaml: -------------------------------------------------------------------------------- 1 | packages: 2 | - 'packages/**' 3 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | maven { url 'https://s01.oss.sonatype.org/content/repositories/releases' } 4 | maven { url 'https://maven.aliyun.com/repository/gradle-plugin' } 5 | maven { url 'https://maven.aliyun.com/repository/spring-plugin' } 6 | maven { url 'https://repo.spring.io/milestone' } 7 | gradlePluginPortal() 8 | } 9 | } 10 | rootProject.name = 'plugin-search-widget' 11 | 12 | -------------------------------------------------------------------------------- /src/main/java/run/halo/search/widget/SearchView.java: -------------------------------------------------------------------------------- 1 | package run.halo.search.widget; 2 | 3 | import org.springframework.context.annotation.Bean; 4 | import org.springframework.http.MediaType; 5 | import org.springframework.stereotype.Component; 6 | import org.springframework.web.reactive.function.server.*; 7 | import reactor.core.publisher.Mono; 8 | import run.halo.app.search.SearchOption; 9 | import run.halo.app.search.SearchResult; 10 | import run.halo.app.search.SearchService; 11 | 12 | import java.util.List; 13 | import java.util.Map; 14 | 15 | @Component 16 | public class SearchView { 17 | 18 | private final SearchService searchService; 19 | 20 | public SearchView(SearchService searchService) { 21 | this.searchService = searchService; 22 | } 23 | 24 | @Bean 25 | RouterFunction searchView() { 26 | return RouterFunctions.route() 27 | .GET("/search", RequestPredicates.accept(MediaType.TEXT_HTML), this::performSearch) 28 | .build(); 29 | } 30 | 31 | private Mono performSearch(ServerRequest serverRequest) { 32 | int limit = serverRequest.queryParam("limit") 33 | .map(Integer::parseInt) 34 | .orElse(10); 35 | var keyword = serverRequest.queryParam("keyword").orElse(""); 36 | Mono result; 37 | if (keyword.isBlank()) { 38 | var searchResult = new SearchResult(); 39 | searchResult.setTotal(0L); 40 | searchResult.setLimit(limit); 41 | searchResult.setProcessingTimeMillis(0); 42 | searchResult.setHits(List.of()); 43 | result = Mono.just(searchResult); 44 | } else { 45 | var includeTypes = serverRequest.queryParams().get("includeTypes"); 46 | var option = new SearchOption(); 47 | option.setKeyword(keyword); 48 | option.setLimit(limit); 49 | option.setFilterExposed(true); 50 | option.setFilterPublished(true); 51 | option.setFilterRecycled(false); 52 | option.setIncludeTypes(includeTypes); 53 | result = searchService.search(option); 54 | } 55 | return ServerResponse.ok().render("search", Map.of( 56 | "searchResult", result 57 | )); 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /src/main/java/run/halo/search/widget/SearchWidgetHeadProcessor.java: -------------------------------------------------------------------------------- 1 | package run.halo.search.widget; 2 | 3 | import java.util.Properties; 4 | import lombok.RequiredArgsConstructor; 5 | import org.springframework.stereotype.Component; 6 | import org.springframework.util.PropertyPlaceholderHelper; 7 | import org.thymeleaf.context.ITemplateContext; 8 | import org.thymeleaf.model.IModel; 9 | import org.thymeleaf.model.IModelFactory; 10 | import org.thymeleaf.processor.element.IElementModelStructureHandler; 11 | import reactor.core.publisher.Mono; 12 | import run.halo.app.plugin.PluginContext; 13 | import run.halo.app.theme.dialect.TemplateHeadProcessor; 14 | 15 | @Component 16 | @RequiredArgsConstructor 17 | public class SearchWidgetHeadProcessor implements TemplateHeadProcessor { 18 | 19 | static final PropertyPlaceholderHelper PROPERTY_PLACEHOLDER_HELPER = new PropertyPlaceholderHelper("${", "}"); 20 | 21 | private final PluginContext pluginContext; 22 | 23 | @Override 24 | public Mono process(ITemplateContext context, IModel model, 25 | IElementModelStructureHandler structureHandler) { 26 | final IModelFactory modelFactory = context.getModelFactory(); 27 | model.add(modelFactory.createText(searchWidgetScript())); 28 | return Mono.empty(); 29 | } 30 | 31 | private String searchWidgetScript() { 32 | 33 | final Properties properties = new Properties(); 34 | properties.setProperty("version", pluginContext.getVersion()); 35 | 36 | return PROPERTY_PLACEHOLDER_HELPER.replacePlaceholders(""" 37 | 38 | 39 | 40 | 41 | """, properties); 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/java/run/halo/search/widget/SearchWidgetPlugin.java: -------------------------------------------------------------------------------- 1 | package run.halo.search.widget; 2 | 3 | import org.springframework.stereotype.Component; 4 | import run.halo.app.plugin.BasePlugin; 5 | import run.halo.app.plugin.PluginContext; 6 | 7 | /** 8 | * @author ryanwang 9 | */ 10 | @Component 11 | public class SearchWidgetPlugin extends BasePlugin { 12 | 13 | public SearchWidgetPlugin(PluginContext pluginContext) { 14 | super(pluginContext); 15 | } 16 | 17 | @Override 18 | public void start() { 19 | } 20 | 21 | @Override 22 | public void stop() { 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /src/main/resources/extensions/reverseProxy.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: plugin.halo.run/v1alpha1 2 | kind: ReverseProxy 3 | metadata: 4 | name: reverse-proxy-template 5 | rules: 6 | - path: /static/** 7 | file: 8 | directory: static 9 | -------------------------------------------------------------------------------- /src/main/resources/logo.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/main/resources/plugin.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: plugin.halo.run/v1alpha1 2 | kind: Plugin 3 | metadata: 4 | name: PluginSearchWidget 5 | annotations: 6 | # Add supports for Halo App Store 7 | # https://halo.run/store/apps/app-DlacW 8 | "store.halo.run/app-id": "app-DlacW" 9 | spec: 10 | enabled: true 11 | requires: ">=2.17.0" 12 | author: 13 | name: Halo 14 | website: https://github.com/halo-dev 15 | logo: logo.svg 16 | homepage: https://www.halo.run/store/apps/app-DlacW 17 | repo: https://github.com/halo-dev/plugin-search-widget 18 | issues: https://github.com/halo-dev/plugin-search-widget/issues 19 | displayName: "搜索组件" 20 | description: "为 Halo 2.0 提供统一的搜索组件，方便主题端使用。" 21 | license: 22 | - name: "GPL-3.0" 23 | url: "https://github.com/halo-dev/plugin-search-widget/blob/main/LICENSE" 24 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "target": "ES2020", 4 | "experimentalDecorators": true, 5 | "useDefineForClassFields": false, 6 | "module": "ESNext", 7 | "lib": ["ES2020", "DOM", "DOM.Iterable"], 8 | "skipLibCheck": true, 9 | 10 | /* Bundler mode */ 11 | "moduleResolution": "bundler", 12 | "allowImportingTsExtensions": true, 13 | "resolveJsonModule": true, 14 | "isolatedModules": true, 15 | "noEmit": true, 16 | 17 | /* Linting */ 18 | "strict": true, 19 | "noUnusedLocals": true, 20 | "noUnusedParameters": true, 21 | "noFallthroughCasesInSwitch": true 22 | } 23 | } 24 | --------------------------------------------------------------------------------