|
| 1 | +--- |
| 2 | +title: <hx-file-tile> |
| 3 | +also: |
| 4 | + components/file-tiles: File Tiles |
| 5 | + components/icons: Icons |
| 6 | +--- |
| 7 | +{% extends 'element.njk' %} |
| 8 | +{% block content %} |
| 9 | + |
| 10 | + <section> |
| 11 | + <p> |
| 12 | + The custom <code>{{page.title}}</code> element describes the states of |
| 13 | + a downloadable asset. |
| 14 | + </p> |
| 15 | + |
| 16 | + <hx-dl class="hxBox-md metadata"> |
| 17 | + <hx-def> |
| 18 | + <hx-dt>Permitted Parents</hx-dt> |
| 19 | + <hx-dd>any</hx-dd> |
| 20 | + </hx-def> |
| 21 | + <hx-def> |
| 22 | + <hx-dt>Permitted Children</hx-dt> |
| 23 | + <hx-dd>flow content</hx-dd> |
| 24 | + </hx-def> |
| 25 | + <hx-def> |
| 26 | + <hx-dt>Events</hx-dt> |
| 27 | + <hx-dd> |
| 28 | + Any of the following: |
| 29 | + <ul> |
| 30 | + <li> |
| 31 | + <code>cancel</code> - User clicks "X" when loading or invalid. |
| 32 | + </li> |
| 33 | + <li> |
| 34 | + <code>delete</code> - User clicks "X" to delete the file. |
| 35 | + </li> |
| 36 | + </ul> |
| 37 | + </hx-dd> |
| 38 | + </hx-def> |
| 39 | + </hx-dl> |
| 40 | + </section> |
| 41 | +{% endblock %} |
| 42 | + |
| 43 | +{% block attributes %} |
| 44 | + <dl> |
| 45 | + <dt>name {String} <i>(optional)</i></dt> |
| 46 | + <dd> |
| 47 | + Sets the text of the name. |
| 48 | + If absent or blank, the name will not be displayed. |
| 49 | + </dd> |
| 50 | + |
| 51 | + <dt>href {String} <i>(optional)</i></dt> |
| 52 | + <dd> |
| 53 | + Sets the path of the href. |
| 54 | + If absent, file name will not be a clickable link. |
| 55 | + Avoid setting this attribute until the file exists on the server. |
| 56 | + </dd> |
| 57 | + |
| 58 | + <dt>icon {Enum<String>} <i>(optional)</i></dt> |
| 59 | + <dd> |
| 60 | + Changes the displayed icon to one of the |
| 61 | + <a href="components/icons/#available-icons">available icons.</a> |
| 62 | + If absent, blank, or unrecognized, the icon will not be displayed. |
| 63 | + </dd> |
| 64 | + |
| 65 | + <dt>loading {Boolean [false]} <i>(optional)</i></dt> |
| 66 | + <dd> |
| 67 | + When present, indicates file upload is in progress. |
| 68 | + </dd> |
| 69 | + |
| 70 | + <dt>invalid {Boolean [false]} <i>(optional)</i></dt> |
| 71 | + <dd> |
| 72 | + When present, marks element invalid. |
| 73 | + </dd> |
| 74 | + </dl> |
| 75 | +{% endblock %} |
| 76 | + |
| 77 | +{% block properties %} |
| 78 | + <dl> |
| 79 | + <dt>name {String}</dt> |
| 80 | + <dd> |
| 81 | + Manipulates the <code>name</code> attribute. |
| 82 | + </dd> |
| 83 | + |
| 84 | + <dt>href {String}</dt> |
| 85 | + <dd> |
| 86 | + Manipulates the <code>href</code> attribute. |
| 87 | + </dd> |
| 88 | + |
| 89 | + <dt>icon {String}</dt> |
| 90 | + <dd> |
| 91 | + Manipulates the <code>icon</code> attribute. |
| 92 | + </dd> |
| 93 | + |
| 94 | + <dt>loading {Boolean}</dt> |
| 95 | + <dd> |
| 96 | + Manipulates the <code>loading</code> attribute. |
| 97 | + </dd> |
| 98 | + |
| 99 | + <dt>valid {Boolean}</dt> |
| 100 | + <dd> |
| 101 | + Manipulates the <code>invalid</code> attribute. |
| 102 | + </dd> |
| 103 | + </dl> |
| 104 | +{% endblock %} |
0 commit comments