mirror of
https://github.com/discourse/discourse.git
synced 2024-11-25 07:51:36 +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>
50 lines
1.3 KiB
JSON
50 lines
1.3 KiB
JSON
{
|
|
"name": "float-kit",
|
|
"version": "1.0.0",
|
|
"description": "Discourse's floating panels component.",
|
|
"author": "Discourse",
|
|
"license": "GPL-2.0-only",
|
|
"keywords": [
|
|
"ember-addon"
|
|
],
|
|
"scripts": {
|
|
"build": "ember build",
|
|
"lint:hbs": "ember-template-lint .",
|
|
"lint:js": "eslint .",
|
|
"start": "ember serve"
|
|
},
|
|
"dependencies": {
|
|
"ember-auto-import": "^2.6.3",
|
|
"ember-cli-babel": "^7.26.11",
|
|
"ember-cli-htmlbars": "^6.3.0",
|
|
"ember-template-imports": "^3.4.2"
|
|
},
|
|
"devDependencies": {
|
|
"@babel/core": "^7.22.10",
|
|
"@ember/optional-features": "^2.0.0",
|
|
"@ember/string": "^3.1.1",
|
|
"@embroider/test-setup": "^3.0.1",
|
|
"@glimmer/component": "^1.1.2",
|
|
"broccoli-asset-rev": "^3.0.0",
|
|
"ember-cli": "~5.0.0",
|
|
"ember-cli-inject-live-reload": "^2.1.0",
|
|
"ember-cli-sri": "^2.1.1",
|
|
"ember-cli-terser": "^4.0.2",
|
|
"ember-disable-prototype-extensions": "^1.1.3",
|
|
"ember-load-initializers": "^2.1.1",
|
|
"ember-resolver": "^10.1.1",
|
|
"ember-source": "~3.28.12",
|
|
"ember-source-channel-url": "^3.0.0",
|
|
"loader.js": "^4.7.0",
|
|
"webpack": "^5.88.2"
|
|
},
|
|
"engines": {
|
|
"node": "16.* || >= 18",
|
|
"npm": "please-use-yarn",
|
|
"yarn": ">= 1.21.1"
|
|
},
|
|
"ember": {
|
|
"edition": "default"
|
|
}
|
|
}
|