mirror of
https://github.com/discourse/discourse.git
synced 2025-01-22 08:59:20 +08:00
2a10ea0e3f
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>
66 lines
1.4 KiB
SCSS
66 lines
1.4 KiB
SCSS
@import "_topic-list";
|
|
@import "about";
|
|
@import "activation";
|
|
@import "alert";
|
|
@import "bbcode";
|
|
@import "cat_reorder";
|
|
@import "category-list";
|
|
@import "code_highlighting";
|
|
@import "colorpicker";
|
|
@import "compose";
|
|
@import "composer-user-selector";
|
|
@import "crawler_layout";
|
|
@import "d-image-grid";
|
|
@import "d-icon";
|
|
@import "dialog";
|
|
@import "directory";
|
|
@import "discourse";
|
|
@import "edit-category";
|
|
@import "edit-topic-timer-modal";
|
|
@import "empty-state";
|
|
@import "ember-select";
|
|
@import "emoji";
|
|
@import "exception";
|
|
@import "explain-reviewable";
|
|
@import "faqs";
|
|
@import "group";
|
|
@import "groups";
|
|
@import "header";
|
|
@import "history";
|
|
@import "lightbox";
|
|
@import "login";
|
|
@import "magnific-popup";
|
|
@import "menu-panel";
|
|
@import "modal";
|
|
@import "new-user";
|
|
@import "not-found";
|
|
@import "onebox";
|
|
@import "personal-message";
|
|
@import "popup-menu";
|
|
@import "redirection";
|
|
@import "request_access";
|
|
@import "request-group-membership-form";
|
|
@import "reviewables";
|
|
@import "rtl";
|
|
@import "search-menu";
|
|
@import "search";
|
|
@import "share_link";
|
|
@import "shared-drafts";
|
|
@import "sidebar";
|
|
@import "sidebar-custom-section";
|
|
@import "sidebar-footer";
|
|
@import "sidebar-section";
|
|
@import "sidebar-more-section-links";
|
|
@import "sidebar-section-link";
|
|
@import "static-login";
|
|
@import "tagging";
|
|
@import "tooltip";
|
|
@import "topic-admin-menu";
|
|
@import "topic-post";
|
|
@import "topic-summary";
|
|
@import "topic";
|
|
@import "upload";
|
|
@import "user-badges";
|
|
@import "user-tips";
|
|
@import "user";
|