mirror of
https://github.com/discourse/discourse.git
synced 2024-11-26 02:23:37 +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> |
||
|---|---|---|
| .. | ||
| composer | ||
| emojis | ||
| helpers | ||
| page_objects | ||
| user_page | ||
| admin_customize_form_templates_spec.rb | ||
| admin_customize_themes_spec.rb | ||
| bookmarks_spec.rb | ||
| category_edit_spec.rb | ||
| category_topics_spec.rb | ||
| composer_uploads_spec.rb | ||
| csv_exports_spec.rb | ||
| custom_sidebar_sections_spec.rb | ||
| discovery_breadcrumb_navigation_spec.rb | ||
| dismissing_new_spec.rb | ||
| editing_sidebar_categories_navigation_spec.rb | ||
| editing_sidebar_community_section_spec.rb | ||
| editing_sidebar_tags_navigation_spec.rb | ||
| ember_deprecation_test.rb | ||
| fast_edit_spec.rb | ||
| filtering_topics_spec.rb | ||
| grant_badge_spec.rb | ||
| group_card_spec.rb | ||
| hashtag_autocomplete_spec.rb | ||
| keyboard_shortcuts_spec.rb | ||
| network_disconnected_spec.rb | ||
| new_topic_list_spec.rb | ||
| reviewables_spec.rb | ||
| s3_secure_uploads_spec.rb | ||
| s3_uploads_spec.rb | ||
| scroll_manager_service_spec.rb | ||
| search_spec.rb | ||
| tag_notification_level_spec.rb | ||
| tag_synonyms_spec.rb | ||
| theme_qunit_spec.rb | ||
| topic_list_focus_spec.rb | ||
| topic_page_spec.rb | ||
| user_selector_spec.rb | ||
| viewing_category_spec.rb | ||
| viewing_group_members_spec.rb | ||
| viewing_navigation_menu_preferences_spec.rb | ||
| viewing_sidebar_as_anonymous_user_spec.rb | ||
| viewing_sidebar_mobile_spec.rb | ||
| viewing_sidebar_spec.rb | ||
| viewing_user_menu_spec.rb | ||
| viewing_user_private_messages_spec.rb | ||