Template:Image frame: Difference between revisions
(Strip "px" from width, height, and border-width parameters) |
(Added parameter to specify CSS class) |
||
Line 18: | Line 18: | ||
clip-path: {{#lvar:clip-path}}; | clip-path: {{#lvar:clip-path}}; | ||
background: {{{border-color|{{{bc|black}}}}}}; | background: {{{border-color|{{{bc|black}}}}}}; | ||
">|}}<div style=" | ">|}}<div {{#if:{{{class|}}}|class="{{{class|}}}"}} style=" | ||
margin: {{#lvar:border-width}}px; | margin: {{#lvar:border-width}}px; | ||
width: {{#lvar:width}}px; | width: {{#lvar:width}}px; | ||
Line 46: | Line 46: | ||
| bw = 2px | | bw = 2px | ||
| bc = red | | bc = red | ||
| class = bg3wiki-image-quote-image | |||
}} | }} | ||
</nowiki> | </nowiki> | ||
Line 125: | Line 126: | ||
"type": "number", | "type": "number", | ||
"default": "4", | "default": "4", | ||
"required": false | |||
}, | |||
"class": { | |||
"label": "Class", | |||
"description": "A CSS class to apply to the image div.", | |||
"type": "string", | |||
"required": false | "required": false | ||
} | } |
Revision as of 21:18, 20 July 2024
Render an image cropped into a frame of arbitrary shape. The shape of the border or frame is defined by a CSS clip-path or can use one of the predefined shapes (rounded, diamond, basic).
Examples
Markup | Renders as |
---|---|
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | width = 120 | border-shape = diamond | border-width = 4 }} | |
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | h = 120px | bs = rounded | bw = 2px | bc = red | class = bg3wiki-image-quote-image }} | |
{{Image frame | image = Portrait Lae'zel.png | link = Lae'zel | height = 120 | border-shape = polygon(20% 0%, 80% 0%, 100% 20%, 100% 80%, 80% 100%, 20% 100%, 0% 80%, 0% 20%); | border-width = 2 | border-color = #3d3d3d }} | |
{{Image frame|Portrait Lae'zel.png|Lae'zel|h=120|bw=0}} |
Template data
Render an image cropped into a frame of arbitrary shape.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Image | 1 image | The image file to display. | File | required |
Link | 2 link | Clicking the image redirects to this link instead of the image file. | Page name | suggested |
Height | height h | The height of the image in pixels (does not include any additional height from the border size).
| Number | suggested |
Width | width w | The width of the image in pixels (does not include any additional width from the border size).
| Number | optional |
Border shape | border-shape bs | The shape of the border frame. It can be an arbitrary CSS clip path or use one of the predefined values.
| String | suggested |
Border color | border-color bc | The color of the border frame. This can be any CSS color descriptor.
| String | optional |
Border width | border-width bw | The thickness of the border frame in pixels. Set this to 0 to disable the border entirely.
| Number | optional |
Class | class | A CSS class to apply to the image div. | String | optional |