DEV: FloatKit (#23650)
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>
2023-09-26 19:39:52 +08:00
|
|
|
export const FLOAT_UI_PLACEMENTS = [
|
|
|
|
|
"top",
|
|
|
|
|
"top-start",
|
|
|
|
|
"top-end",
|
|
|
|
|
"right",
|
|
|
|
|
"right-start",
|
|
|
|
|
"right-end",
|
|
|
|
|
"bottom",
|
|
|
|
|
"bottom-start",
|
|
|
|
|
"bottom-end",
|
|
|
|
|
"left",
|
|
|
|
|
"left-start",
|
|
|
|
|
"left-end",
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
export const TOOLTIP = {
|
|
|
|
|
options: {
|
|
|
|
|
animated: true,
|
|
|
|
|
arrow: true,
|
|
|
|
|
beforeTrigger: null,
|
|
|
|
|
closeOnClickOutside: true,
|
|
|
|
|
closeOnEscape: true,
|
|
|
|
|
closeOnScroll: true,
|
|
|
|
|
component: null,
|
|
|
|
|
content: null,
|
|
|
|
|
identifier: null,
|
|
|
|
|
interactive: false,
|
|
|
|
|
listeners: false,
|
|
|
|
|
maxWidth: 350,
|
|
|
|
|
data: null,
|
|
|
|
|
offset: 10,
|
|
|
|
|
triggers: ["hover", "click"],
|
|
|
|
|
untriggers: ["hover", "click"],
|
|
|
|
|
placement: "top",
|
|
|
|
|
fallbackPlacements: FLOAT_UI_PLACEMENTS,
|
|
|
|
|
autoUpdate: true,
|
|
|
|
|
trapTab: true,
|
|
|
|
|
},
|
|
|
|
|
portalOutletId: "d-tooltip-portal-outlet",
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
export const MENU = {
|
|
|
|
|
options: {
|
|
|
|
|
animated: true,
|
|
|
|
|
arrow: false,
|
|
|
|
|
beforeTrigger: null,
|
|
|
|
|
closeOnEscape: true,
|
|
|
|
|
closeOnClickOutside: true,
|
|
|
|
|
closeOnScroll: false,
|
|
|
|
|
component: null,
|
|
|
|
|
content: null,
|
|
|
|
|
identifier: null,
|
|
|
|
|
interactive: true,
|
|
|
|
|
listeners: false,
|
|
|
|
|
maxWidth: 400,
|
|
|
|
|
data: null,
|
|
|
|
|
offset: 10,
|
|
|
|
|
triggers: ["click"],
|
|
|
|
|
untriggers: ["click"],
|
|
|
|
|
placement: "bottom",
|
|
|
|
|
fallbackPlacements: FLOAT_UI_PLACEMENTS,
|
|
|
|
|
autoUpdate: true,
|
|
|
|
|
trapTab: true,
|
|
|
|
|
},
|
|
|
|
|
portalOutletId: "d-menu-portal-outlet",
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
import DDefaultToast from "float-kit/components/d-default-toast";
|
|
|
|
|
|
|
|
|
|
export const TOAST = {
|
|
|
|
|
options: {
|
|
|
|
|
autoClose: true,
|
2023-10-19 23:14:49 +08:00
|
|
|
forceAutoClose: false,
|
2023-10-09 20:11:16 +08:00
|
|
|
duration: 3000,
|
DEV: FloatKit (#23650)
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>
2023-09-26 19:39:52 +08:00
|
|
|
component: DDefaultToast,
|
|
|
|
|
},
|
|
|
|
|
};
|