avatars.mdx 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227
  1. ---
  2. title: Avatars
  3. summary: Avatars help customize various elements of a user interface and make the product experience more personalized. They are often used in communication apps, collaboration tools and social media.
  4. description: Personalize UI with user avatars.
  5. ---
  6. ## Default markup
  7. Use the `avatar` class to add an avatar to your interface design for greater customization.
  8. ```html example centered separated code
  9. <span class="avatar" style="background-image: url(/samples/avatars/002f.jpg)"></span>
  10. <span class="avatar">JL</span>
  11. <span class="avatar" style="background-image: url(/samples/avatars/004f.jpg)"></span>
  12. ```
  13. ## Avatar image
  14. Set an image as the background to make users easy to indentify and create a personalized experience.
  15. ```html example centered separated code
  16. <span class="avatar" style="background-image: url(/samples/avatars/016f.jpg)"></span>
  17. <span class="avatar" style="background-image: url(/samples/avatars/022m.jpg)"></span>
  18. <span class="avatar" style="background-image: url(/samples/avatars/036m.jpg)"></span>
  19. ```
  20. ## Initials
  21. You can also use initials instead of pictures.
  22. ```html example centered separated code
  23. <span class="avatar">AB</span>
  24. <span class="avatar">CD</span>
  25. <span class="avatar">EF</span>
  26. <span class="avatar">GH</span>
  27. <span class="avatar">IJ</span>
  28. ```
  29. ## Avatar icons
  30. Besides pictures and initials, you can also use icons to make the avatars more universal.
  31. ```html example centered separated
  32. <span class="avatar">
  33. <svg
  34. xmlns="http://www.w3.org/2000/svg"
  35. class="icon avatar-icon"
  36. width="24"
  37. height="24"
  38. viewBox="0 0 24 24"
  39. stroke-width="2"
  40. stroke="currentColor"
  41. fill="none"
  42. stroke-linecap="round"
  43. stroke-linejoin="round"
  44. >
  45. <path stroke="none" d="M0 0h24v24H0z" fill="none" />
  46. <circle cx="12" cy="7" r="4" />
  47. <path d="M6 21v-2a4 4 0 0 1 4 -4h4a4 4 0 0 1 4 4v2" />
  48. </svg>
  49. </span>
  50. <span class="avatar">
  51. <svg
  52. xmlns="http://www.w3.org/2000/svg"
  53. class="icon avatar-icon"
  54. width="24"
  55. height="24"
  56. viewBox="0 0 24 24"
  57. stroke-width="2"
  58. stroke="currentColor"
  59. fill="none"
  60. stroke-linecap="round"
  61. stroke-linejoin="round"
  62. >
  63. <path stroke="none" d="M0 0h24v24H0z" fill="none" />
  64. <line x1="12" y1="5" x2="12" y2="19" />
  65. <line x1="5" y1="12" x2="19" y2="12" />
  66. </svg>
  67. </span>
  68. <span class="avatar">
  69. <svg
  70. xmlns="http://www.w3.org/2000/svg"
  71. class="icon avatar-icon"
  72. width="24"
  73. height="24"
  74. viewBox="0 0 24 24"
  75. stroke-width="2"
  76. stroke="currentColor"
  77. fill="none"
  78. stroke-linecap="round"
  79. stroke-linejoin="round"
  80. >
  81. <path stroke="none" d="M0 0h24v24H0z" fill="none" />
  82. <circle cx="9" cy="7" r="4" />
  83. <path d="M3 21v-2a4 4 0 0 1 4 -4h4a4 4 0 0 1 4 4v2" />
  84. <path d="M16 11h6m-3 -3v6" />
  85. </svg>
  86. </span>
  87. ```
  88. ```html
  89. <span class="avatar">
  90. <!-- SVG icon from http://tabler.io/icons/icon/user -->
  91. <svg>...</svg>
  92. </span>
  93. ```
  94. ## Avatar initials color
  95. Customize the color of the avatars' background. You can click [here](/docs/ui/base/colors) to see the list of available colors.
  96. ```html example centered separated code
  97. <span class="avatar bg-green-lt">AB</span>
  98. <span class="avatar bg-red-lt">CD</span>
  99. <span class="avatar bg-yellow-lt">EF</span>
  100. <span class="avatar bg-primary-lt">GH</span>
  101. <span class="avatar bg-purple-lt">IJ</span>
  102. ```
  103. ## Avatar size
  104. Using Bootstrap’s typical naming structure, you can create a standard avatar or scale it up or down to different sizes based on what you need.
  105. ```html example centered separated code
  106. <span class="avatar avatar-xl" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  107. <span class="avatar avatar-lg" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  108. <span class="avatar avatar-md" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  109. <span class="avatar" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  110. <span class="avatar avatar-sm" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  111. <span class="avatar avatar-xs" style="background-image: url(/samples/avatars/000m.jpg)"></span>
  112. ```
  113. ## Avatar status
  114. Add a status indicator to your avatar to show, for instance, if a user is online or offline or indicate the number of messages they have received.
  115. ```html example centered separated code
  116. <span class="avatar" style="background-image: url(/samples/avatars/018m.jpg)"></span>
  117. <span class="avatar" style="background-image: url(/samples/avatars/015m.jpg)">
  118. <span class="badge bg-danger"></span>
  119. </span>
  120. <span class="avatar" style="background-image: url(/samples/avatars/022m.jpg)">
  121. <span class="badge bg-success"></span>
  122. </span>
  123. <span class="avatar"> <span class="badge bg-warning"></span>SA </span>
  124. <span class="avatar" style="background-image: url(/samples/avatars/022m.jpg)">
  125. <span class="badge bg-info"></span>
  126. </span>
  127. <span class="avatar" style="background-image: url(/samples/avatars/048m.jpg)">
  128. <span class="badge bg-gray">5</span>
  129. </span>
  130. ```
  131. ## Avatar shape
  132. Change the shape of an avatar with the default Bootstrap image classes. You can make them round or square and change their border radius.
  133. ```html example centered separated
  134. <span class="avatar" style="background-image: url(/samples/avatars/019m.jpg)"></span>
  135. <span class="avatar rounded" style="background-image: url(/samples/avatars/039f.jpg)"></span>
  136. <span class="avatar rounded-circle">AA</span>
  137. <span class="avatar rounded-0" style="background-image: url(/samples/avatars/043f.jpg)"></span>
  138. <span class="avatar rounded-3" style="background-image: url(/samples/avatars/044f.jpg)"></span>
  139. ```
  140. ## Avatars list
  141. Create a list of avatars within one parent container.
  142. ```html example centered separated code
  143. <div class="avatar-list">
  144. <span class="avatar rounded" style="background-image: url(/samples/avatars/031f.jpg)"></span>
  145. <span class="avatar rounded">JL</span>
  146. <span class="avatar rounded" style="background-image: url(/samples/avatars/033f.jpg)"></span>
  147. <span class="avatar rounded" style="background-image: url(/samples/avatars/017m.jpg)"></span>
  148. <span class="avatar rounded" style="background-image: url(/samples/avatars/024m.jpg)"></span>
  149. </div>
  150. ```
  151. ## Stacked list
  152. Make the list stack once a certain number of avatars is reached to make it look clear and display well regardless of the screen size.
  153. ```html example centered separated code
  154. <div class="avatar-list avatar-list-stacked">
  155. <span class="avatar">EB</span>
  156. <span class="avatar" style="background-image: url(/samples/avatars/026m.jpg)"></span>
  157. <span class="avatar" style="background-image: url(/samples/avatars/016f.jpg)"></span>
  158. <span class="avatar" style="background-image: url(/samples/avatars/028m.jpg)"></span>
  159. <span class="avatar" style="background-image: url(/samples/avatars/030m.jpg)"></span>
  160. <span class="avatar">+8</span>
  161. </div>
  162. ```
  163. ```html example centered separated code
  164. <div class="avatar-list avatar-list-stacked">
  165. <span
  166. class="avatar avatar-sm rounded-circle"
  167. style="background-image: url(/samples/avatars/035m.jpg)"
  168. ></span>
  169. <span
  170. class="avatar avatar-sm rounded-circle"
  171. style="background-image: url(/samples/avatars/027f.jpg)"
  172. ></span>
  173. <span
  174. class="avatar avatar-sm rounded-circle"
  175. style="background-image: url(/samples/avatars/036f.jpg)"
  176. ></span>
  177. <span class="avatar avatar-sm rounded-circle">SA</span>
  178. <span
  179. class="avatar avatar-sm rounded-circle"
  180. style="background-image: url(/samples/avatars/034f.jpg)"
  181. ></span>
  182. <span
  183. class="avatar avatar-sm rounded-circle"
  184. style="background-image: url(/samples/avatars/043f.jpg)"
  185. ></span>
  186. <span
  187. class="avatar avatar-sm rounded-circle"
  188. style="background-image: url(/samples/avatars/039f.jpg)"
  189. ></span>
  190. <span
  191. class="avatar avatar-sm rounded-circle"
  192. style="background-image: url(/samples/avatars/020m.jpg)"
  193. ></span>
  194. </div>
  195. ```