@craydel/craydel-avatar-group

CraydelAvatarGroup

Installation

Get the latest version by NPM:

$ npm i @craydel/craydel-avatar-group

Register Plugin

If you use the plugin API, the component will be registered as a global component just like when including it with the script tag, but you won't need to re-register it through the components property in your own components.

Create the plugin file e.g craydel-components.js file.

// craydel-components.js
import Vue from 'vue'
import CraydelAvatarGroup from '@craydel/craydel-avatar-group/src/CraydelAvatarGroup.vue'

const Components = {
  CraydelAvatarGroup,
};

Object.keys(Components).forEach(name => {
  Vue.component(name, Components[name]);
});

export default Components;

Next reference the plugin file in your nuxt.config.js

// Plugins to run before rendering page: https://go.nuxtjs.dev/config-plugins
plugins: [
  '~/plugins/craydel-components.js'
]

Props

Name	Type	Default	Description
size	number | string	40	Sets the height and width of the component.
users	array	[]	Array of objects for each user. Will look for a display_name, email, photo and acronym keys. In case there is no photo url provided, the acronym will be used to display the initials.

 

Usage

An example showing an avatar group of users.

<craydel-avatar-group
        :users="users"
></craydel-avatar-group>

data() {
  return {
    users: [
      {
        display_name: "John Smitt",
        email: "[e-mail]",
        photo: '',
        acronym: "JS"
      },
      {
        display_name: "Frankie Dowle",
        email: "[e-mail]",
        photo: "https://randomuser.me/api/portraits/med/men/3.jpg",
        acronym: "FD"
      }
    ],
  }
}