mirror of
https://github.com/discourse/discourse.git
synced 2024-11-29 03:03:44 +08:00
0623ac684a
Second iteration of https://github.com/discourse/discourse/pull/23312 with a fix for embroider not resolving an export file using .gjs extension. --- This PR introduces three new concepts to Discourse codebase through an addon called "FloatKit": - menu - tooltip - toast ## Tooltips ### Component Simple cases can be express with an API similar to DButton: ```hbs <DTooltip @label={{i18n "foo.bar"}} @icon="check" @content="Something" /> ``` More complex cases can use blocks: ```hbs <DTooltip> <:trigger> {{d-icon "check"}} <span>{{i18n "foo.bar"}}</span> </:trigger> <:content> Something </:content> </DTooltip> ``` ### Service You can manually show a tooltip using the `tooltip` service: ```javascript const tooltipInstance = await this.tooltip.show( document.querySelector(".my-span"), options ) // and later manual close or destroy it tooltipInstance.close(); tooltipInstance.destroy(); // you can also just close any open tooltip through the service this.tooltip.close(); ``` The service also allows you to register event listeners on a trigger, it removes the need for you to manage open/close of a tooltip started through the service: ```javascript const tooltipInstance = this.tooltip.register( document.querySelector(".my-span"), options ) // when done you can destroy the instance to remove the listeners tooltipInstance.destroy(); ``` Note that the service also allows you to use a custom component as content which will receive `@data` and `@close` as args: ```javascript const tooltipInstance = await this.tooltip.show( document.querySelector(".my-span"), { component: MyComponent, data: { foo: 1 } } ) ``` ## Menus Menus are very similar to tooltips and provide the same kind of APIs: ### Component ```hbs <DMenu @icon="plus" @label={{i18n "foo.bar"}}> <ul> <li>Foo</li> <li>Bat</li> <li>Baz</li> </ul> </DMenu> ``` They also support blocks: ```hbs <DMenu> <:trigger> {{d-icon "plus"}} <span>{{i18n "foo.bar"}}</span> </:trigger> <:content> <ul> <li>Foo</li> <li>Bat</li> <li>Baz</li> </ul> </:content> </DMenu> ``` ### Service You can manually show a menu using the `menu` service: ```javascript const menuInstance = await this.menu.show( document.querySelector(".my-span"), options ) // and later manual close or destroy it menuInstance.close(); menuInstance.destroy(); // you can also just close any open tooltip through the service this.menu.close(); ``` The service also allows you to register event listeners on a trigger, it removes the need for you to manage open/close of a tooltip started through the service: ```javascript const menuInstance = this.menu.register( document.querySelector(".my-span"), options ) // when done you can destroy the instance to remove the listeners menuInstance.destroy(); ``` Note that the service also allows you to use a custom component as content which will receive `@data` and `@close` as args: ```javascript const menuInstance = await this.menu.show( document.querySelector(".my-span"), { component: MyComponent, data: { foo: 1 } } ) ``` ## Toasts Interacting with toasts is made only through the `toasts` service. A default component is provided (DDefaultToast) and can be used through dedicated service methods: - this.toasts.success({ ... }); - this.toasts.warning({ ... }); - this.toasts.info({ ... }); - this.toasts.error({ ... }); - this.toasts.default({ ... }); ```javascript this.toasts.success({ data: { title: "Foo", message: "Bar", actions: [ { label: "Ok", class: "btn-primary", action: (componentArgs) => { // eslint-disable-next-line no-alert alert("Closing toast:" + componentArgs.data.title); componentArgs.close(); }, } ] }, }); ``` You can also provide your own component: ```javascript this.toasts.show(MyComponent, { autoClose: false, class: "foo", data: { baz: 1 }, }) ``` Co-authored-by: Martin Brennan <mjrbrennan@gmail.com> Co-authored-by: Isaac Janzen <50783505+janzenisaac@users.noreply.github.com> Co-authored-by: David Taylor <david@taylorhq.com> Co-authored-by: Jarek Radosz <jradosz@gmail.com>
49 lines
1.3 KiB
SCSS
49 lines
1.3 KiB
SCSS
@import "badges";
|
|
@import "banner";
|
|
@import "bookmark-list";
|
|
@import "bookmark-modal";
|
|
@import "buttons";
|
|
@import "color-input";
|
|
@import "char-counter";
|
|
@import "conditional-loading-section";
|
|
@import "calendar-date-time-input";
|
|
@import "convert-to-public-topic-modal";
|
|
@import "d-lightbox";
|
|
@import "d-toggle-switch";
|
|
@import "date-input";
|
|
@import "date-picker";
|
|
@import "date-time-input-range";
|
|
@import "date-time-input";
|
|
@import "footer-nav";
|
|
@import "form-template-field";
|
|
@import "group-member-dropdown";
|
|
@import "groups-form-membership-fields";
|
|
@import "hashtag";
|
|
@import "horizontal-overflow-nav";
|
|
@import "iframed-html";
|
|
@import "ignored-user-list";
|
|
@import "keyboard_shortcuts";
|
|
@import "more-topics";
|
|
@import "navs";
|
|
@import "offline-indicator";
|
|
@import "pick-files-button";
|
|
@import "relative-time-picker";
|
|
@import "share-and-invite-modal";
|
|
@import "download-calendar";
|
|
@import "sidebar/edit-navigation-menu/categories-modal";
|
|
@import "sidebar/edit-navigation-menu/modal";
|
|
@import "sidebar/edit-navigation-menu/tags-modal";
|
|
@import "svg";
|
|
@import "tap-tile";
|
|
@import "time-input";
|
|
@import "time-shortcut-picker";
|
|
@import "topic-query-filter";
|
|
@import "user-card";
|
|
@import "user-info";
|
|
@import "user-status-message";
|
|
@import "user-status-picker";
|
|
@import "user-stream-item";
|
|
@import "user-stream";
|
|
@import "widget-dropdown";
|
|
@import "admin-post-menu";
|