Skip to content

Commit 30b97dd

Browse files
yash-chowdharynbriannl
authored andcommitted
UserGuide: Document the use of icon-size in boxes (MarkBind#1021)
1 parent 5f62a3e commit 30b97dd

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/userGuide/syntax/boxes.mbdf

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,37 @@
160160
</span>
161161
</include>
162162

163+
**You can also use icons and resize them accordingly.**
164+
165+
<include src="outputBox.md" boilerplate >
166+
<span id="code">
167+
```html
168+
<box type="warning" icon=":fas-camera:">
169+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
170+
</box>
171+
<box type="warning" icon=":fas-camera:" icon-size="2x">
172+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
173+
</box>
174+
<box type="warning" icon=":fas-camera:" icon-size="3x">
175+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
176+
</box>
177+
```
178+
</span>
179+
180+
<span id="output">
181+
182+
<box type="warning" icon=":fas-camera:">
183+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
184+
</box>
185+
<box type="warning" icon=":fas-camera:" icon-size="2x">
186+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
187+
</box>
188+
<box type="warning" icon=":fas-camera:" icon-size="3x">
189+
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
190+
</box>
191+
</span>
192+
</include>
193+
163194
****Options****
164195
Name | Type | Default | Description
165196
--- | --- | --- | ---
@@ -169,6 +200,7 @@ border-left-color | `String` | `null` | Overrides border-color for the left bord
169200
color | `String` | `null` | Color of the text.
170201
dismissible | `Boolean` | `false` | Adds a button to close the box to the top right corner.
171202
icon | `String` | `null` | Inline MarkDown text of the icon displayed on the left.
203+
icon-size | `String` | `null` | Resizes the icon. Supports integer-scaling of the icon dimensions e.g. `2x`, `3x`, `4x`, etc.
172204
header <hr style="margin-top:0.2rem; margin-bottom:0" /> <small>heading <br> (deprecated)</small> | `String` | `null` | Plain text of the header on the top right corner.
173205
type | `String` | `'none'` | Supports: `info`, `warning`, `success`, `important`, `wrong`, `tip`, `definition`, or empty for default.
174206
light | `Boolean` | `false` | Uses a light color scheme for the box.

0 commit comments

Comments
 (0)