-
Notifications
You must be signed in to change notification settings - Fork 1
/
en.yml
151 lines (150 loc) · 9.05 KB
/
en.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
en:
theme_metadata:
settings:
links:
description: |
Text links to be displayed in the header.
<br><br><br>
<h2>Location</h2>
You can choose specific pages and various places to display the links on.
schema:
properties:
emoji:
label: Emoji
description: >
The emoji to display for the links.<br>
<details><summary>Shortcuts</summary><div>Windows: <kbd>Win</kbd> + <kbd>.</kbd></div><div>Mac: <kbd>Cmd</kbd> + <kbd>Ctrl</kbd> + <kbd>Space</kbd></div></details>
text:
label: Title
description: The title of the link.
description:
label: Description
description: The description of the link.
url:
label: URL
description: The URL to link to.
target:
label: Target
description: >
Opens the linked document:<br>
<code>_blank</code>: in a new window or tab (this is default)<br>
<code>_self</code>: in the same frame as it was clicked<br>
<code>_parent</code>: in the parent frame<br>
<code>_top</code>: in the full body of the window
<br><br><br>
<h2>Button Styling</h2>
You can overwrite the default styling here for this link.<br>
If the settings are not enough, you can easily add a custom CSS class name (see below) to target the link outside this component.
button_width:
label: Width
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/width" target="_blank" title="'width' CSS Documentation">width</a> of the button.
button_rounding:
label: Rounding
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius" target="_blank" title="'border-radius' CSS Documentation">amount of rounding</a> to apply to the button.
button_background:
label: Background
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/background-color" target="_blank" title="'background-color' CSS Documentation">background color</a> of the button.
button_background_hover:
label: Background Hover
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/background-color" target="_blank" title="'background-color' CSS Documentation">background color</a> of the button when hovered.
button_color:
label: Color
description: The text <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color" target="_blank" title="'color' CSS Documentation">color</a> of the button.
button_shadow_color:
label: Shadow Color
description: The shadow <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color" target="_blank" title="'color' CSS Documentation">color</a> of the button.
button_identifier:
label: CSS Classname
description: |
A custom CSS class to apply to the button.
Useful if you want to style the button differently and the settings are not enough.
You can target with <code>.banner-featured-links__link.your-classname {}</code>
show_on:
description: >
The pages to display the links on.
<code>top_menu</code> refers to the <a href="/admin/site_settings/category/all_results?filter=top_menu">top menu site.
plugin_outlet:
description: |
The location to display the links.<br>
<details>
<summary>Common Locations</summary>
<code>above-main-container</code>
<code>above-site-header</code>
<code>after-header</code>
<code>before-header-panel</code>
<code>before-list-area</code>
<code>before-topic-list</code>
<code>below-site-header</code>
<code>header-list-container-bottom</code>
<code>topic-above-post-stream</code><br>
Search Banner component:<br>
<code>search-banner-below-headline</code>
<code>search-banner-below-input</code>
</details>
<br><br><br>
<h2>Global Styling</h2>
Customize the default spacing and look of the links.<br>
You can overwrite the button styling for each link individually.<br><br>
<h4>Buttons Wrapper Styling</h4>
Customize the container of the links.<br><br>
buttons_wrapper_max_width:
label: Max Width
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/max-width" target="_blank" title="'max-width' CSS Documentation">maximum width</a> of the buttons wrapper.
buttons_wrapper_margin:
label: Margin
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/margin" target="_blank" title="'background-color' CSS Documentation">margin</a> of the buttons wrapper.<br><br>
mobile_buttons_wrapper_max_width:
label: (Mobile) Max Width
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/max-width" target="_blank" title="'max-width' CSS Documentation">maximum width</a> of the buttons wrapper on mobile.
mobile_buttons_wrapper_margin:
label: (Mobile) Margin
description: |
The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/margin" target="_blank" title="'background-color' CSS Documentation">margin</a> of the buttons wrapper on mobile.
<br><br><br>
<h4>Buttons Spacing & Text Font Size</h4>
Customize the spacing of the buttons and the font size of the text.
buttons_justify:
label: Justify
description: |
How to distribute <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content" target="_blank" title="'justify-content' CSS Documentation">space</a> between and around links.<br>
buttons_gap:
label: Gap
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/gap" target="_blank" title="'gap' CSS Documentation">gap</a> between the buttons.
buttons_font_size:
label: Font Size
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/font-size" target="_blank" title="'font-size' CSS Documentation">size</a> of the font of the buttons.<br><br>
mobile_buttons_gap:
label: (Mobile) Gap
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/gap" target="_blank" title="'gap' CSS Documentation">gap</a> between the buttons on mobile.
mobile_buttons_justify:
label: (Mobile) Justify
description: How to distribute <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/justify-content" target="_blank" title="'justify-content' CSS Documentation">space</a> between and around links on mobile.
mobile_buttons_direction:
label: (Mobile) Direction
description: |
The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction" target="_blank" title="'flex-direction' CSS Documentation">direction</a> of the buttons on mobile.
mobile_buttons_font_size:
label: (Mobile) Font Size
description: |
The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/font-size" target="_blank" title="'font-size' CSS Documentation">size</a> of the font of the buttons on mobile.
<br><br><br>
<h4>Button Styling</h4>
Customize the default look of the buttons.
button_width:
label: Button Width
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/width" target="_blank" title="'width' CSS Documentation">width</a> of the button.<br>
button_rounding:
label: Button Rounding
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/border-radius" target="_blank" title="'border-radius' CSS Documentation">amount of rounding</a> to apply to the button.
button_background:
label: Button Background
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/background-color" target="_blank" title="'background-color' CSS Documentation">background color</a> of the button.
button_background_hover:
label: Button Background Hover
description: The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/background-color" target="_blank" title="'background-color' CSS Documentation">background color</a> of the button when hovered.
button_color:
label: Button Color
description: The text <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color" target="_blank" title="'color' CSS Documentation">color</a> of the button.
button_shadow_color:
label: Button Shadow Color
description: The shadow <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color" target="_blank" title="'color' CSS Documentation">color</a> of the button.