mirror of
https://github.com/discourse/discourse.git
synced 2024-12-24 10:53:46 +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>
271 lines
4.7 KiB
SCSS
271 lines
4.7 KiB
SCSS
@import "colors";
|
|
@import "typography";
|
|
|
|
.styleguide {
|
|
display: flex;
|
|
|
|
.styleguide-note {
|
|
padding: 1em;
|
|
background-color: var(--tertiary);
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
.styleguide-menu {
|
|
margin-top: 1em;
|
|
flex: 1 0 0;
|
|
|
|
ul {
|
|
list-style: none;
|
|
margin-bottom: 1.5em;
|
|
margin-left: 0;
|
|
|
|
li.styleguide-heading {
|
|
color: var(--primary-medium);
|
|
text-transform: uppercase;
|
|
font-size: 14px;
|
|
}
|
|
|
|
li {
|
|
margin-bottom: 0.25em;
|
|
|
|
a {
|
|
color: var(--primary);
|
|
font-size: 14px;
|
|
}
|
|
|
|
a.active {
|
|
font-weight: bold;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
.styleguide-contents {
|
|
flex: 4 0 0;
|
|
}
|
|
|
|
.styleguide-section {
|
|
.section-title {
|
|
font-size: var(--font-up-5);
|
|
font-weight: normal;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
.section-description {
|
|
margin-bottom: 2em;
|
|
}
|
|
|
|
.description {
|
|
margin: 1em 0;
|
|
}
|
|
|
|
.half-size {
|
|
width: 50%;
|
|
}
|
|
|
|
.styleguide-example {
|
|
.example-title {
|
|
color: var(--primary-medium);
|
|
font-size: var(--font-down-1);
|
|
border-bottom: 1px solid var(--primary-low);
|
|
margin-bottom: 1em;
|
|
}
|
|
|
|
.rendered {
|
|
width: 100%;
|
|
position: relative;
|
|
|
|
.component-properties {
|
|
width: 100%;
|
|
|
|
&__row {
|
|
align-items: center;
|
|
display: flex;
|
|
}
|
|
|
|
&__cell {
|
|
padding: 0.5rem 0;
|
|
width: 70%;
|
|
box-sizing: border-box;
|
|
|
|
&:first-child {
|
|
width: 30%;
|
|
box-sizing: border-box;
|
|
}
|
|
|
|
textarea,
|
|
input {
|
|
box-sizing: border-box;
|
|
margin: 0;
|
|
width: 100%;
|
|
}
|
|
|
|
textarea {
|
|
height: 100px;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
margin-bottom: 2em;
|
|
}
|
|
|
|
&.colors-examples {
|
|
.styleguide-example {
|
|
display: flex;
|
|
.example-title {
|
|
min-width: 15%;
|
|
margin-right: 1em;
|
|
border-bottom: none;
|
|
&-text {
|
|
color: var(--primary);
|
|
text-transform: capitalize;
|
|
}
|
|
&-use-case {
|
|
font-size: var(--font-down-1);
|
|
display: block;
|
|
}
|
|
}
|
|
.color-row {
|
|
display: flex;
|
|
|
|
.color-example {
|
|
flex: 1;
|
|
display: flex;
|
|
flex-direction: column;
|
|
height: 120px;
|
|
margin: 0.5em 0.5em 0.5em 0;
|
|
border: 1px solid var(--primary-300);
|
|
|
|
.color-bg {
|
|
flex: 4;
|
|
border-bottom: 1px solid var(--primary-300);
|
|
}
|
|
.color-name {
|
|
flex: 1;
|
|
display: flex;
|
|
align-items: center;
|
|
padding: 0.25em 0.5em;
|
|
font-weight: 700;
|
|
font-size: var(--font-down-1);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
pre {
|
|
background: var(--primary-very-low);
|
|
white-space: pre-wrap;
|
|
&.pre-inline {
|
|
display: inline-block;
|
|
margin: 0;
|
|
vertical-align: bottom;
|
|
}
|
|
span {
|
|
color: var(--primary-medium);
|
|
&.hljs-attribute {
|
|
color: teal;
|
|
}
|
|
}
|
|
}
|
|
|
|
p.reason {
|
|
display: inline;
|
|
color: var(--primary-medium);
|
|
margin: 0 0 0 10px;
|
|
}
|
|
|
|
&--char-counter {
|
|
display: block;
|
|
width: 100%;
|
|
margin-bottom: 0;
|
|
}
|
|
}
|
|
|
|
.buttons-examples {
|
|
button {
|
|
margin-right: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
.d-toggle-switch {
|
|
display: inline-block;
|
|
}
|
|
}
|
|
|
|
.icons-examples,
|
|
.topic-statuses-examples .d-icon {
|
|
margin-right: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
.dropdowns-examples {
|
|
.select-kit.is-hidden {
|
|
display: inline-block;
|
|
}
|
|
}
|
|
|
|
.styleguide-icons {
|
|
display: grid;
|
|
grid-template-columns: 150px 150px 150px 150px 150px;
|
|
grid-gap: 10px;
|
|
|
|
.styleguide-icon {
|
|
background-color: var(--primary-low);
|
|
margin: 3px;
|
|
text-align: center;
|
|
padding: 10px;
|
|
overflow: hidden;
|
|
svg {
|
|
display: block;
|
|
font-size: 3em;
|
|
margin: 5px auto;
|
|
}
|
|
span {
|
|
font-size: var(--font-down-1);
|
|
word-wrap: break-word;
|
|
}
|
|
}
|
|
}
|
|
|
|
.styleguide__component {
|
|
border: 2px dotted var(--primary-low);
|
|
margin-bottom: 2rem;
|
|
position: relative;
|
|
|
|
&-tag {
|
|
position: absolute;
|
|
top: 0;
|
|
right: 0;
|
|
padding: 3px 6px;
|
|
background: var(--primary-low);
|
|
max-width: 25%;
|
|
@include ellipsis;
|
|
}
|
|
|
|
&-sample {
|
|
display: flex;
|
|
padding: 2rem;
|
|
}
|
|
|
|
&-actions {
|
|
display: flex;
|
|
align-items: center;
|
|
padding: 1rem 2rem;
|
|
}
|
|
|
|
&-code {
|
|
display: flex;
|
|
|
|
.ember-view {
|
|
width: 100%;
|
|
}
|
|
|
|
pre {
|
|
margin: 0;
|
|
}
|
|
}
|
|
}
|