ak-profilecard v1.2.0

Profilecard

Installation

npm install ak-profilecard

Using the resourced component

Import the component in your React app as follows:

import AkProfileCardResourced from 'ak-profilecard';
ReactDOM.render(<AkProfileCardResourced />, container );

Using the static component

Import the component in your React app as follows:

import { AkProfilecard } from 'ak-profilecard';
ReactDOM.render(<AkProfileCard />, container);

Classes

ProfilecardResourced

Kind: global class

• Properties

  • profilecardResourced.userId : string
  • profilecardResourced.cloudId : string
  • profilecardResourced.actions : array
  • profilecardResourced.apiEndpoint : string

new ProfilecardResourced()

Create instances of the ProfilecardResourced component in a React context.

profilecardResourced.userId : string

Kind: instance property of ProfilecardResourced

profilecardResourced.cloudId : string

Kind: instance property of ProfilecardResourced

profilecardResourced.actions : array

Defining the action buttons on the card. Array of one or more action objects with label and callback keys. label defines the button text while callback is invoked when the button is clicked.

Kind: instance property of ProfilecardResourced
Example

[{label: 'Chat', callback: () => { ... }}, ... ]

profilecardResourced.apiEndpoint : string

Kind: instance property of ProfilecardResourced

Profilecard

Kind: global class

• Properties

  • profilecard.avatarUrl : string
  • profilecard.fullName : string
  • profilecard.meta : string
  • profilecard.nickname : string
  • profilecard.location : string
  • profilecard.timestring : string
  • profilecard.presence : string
  • profilecard.actions : array

new Profilecard()

Create instances of the Profilecard component in a React context.

profilecard.avatarUrl : string

Kind: instance property of Profilecard

profilecard.fullName : string

Kind: instance property of Profilecard

profilecard.meta : string

Kind: instance property of Profilecard

profilecard.nickname : string

Kind: instance property of Profilecard

profilecard.location : string

Kind: instance property of Profilecard

profilecard.timestring : string

Kind: instance property of Profilecard

profilecard.presence : string

Indicates the users online status by showing a small icon Allowed values: 'available', 'busy', 'unavailable' or 'none'

Kind: instance property of Profilecard
Default: "none"

profilecard.actions : array

Defining the action buttons on the card. Array of one or more action objects with label and callback keys. label defines the button text while callback is invoked when the button is clicked.

Kind: instance property of Profilecard
Example

[{label: 'Chat', callback: () => { ... }}, ... ]

Support and feedback

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Community support

Ask a question in our forum.

Check if someone has already asked the same question before.

Create a support ticket

Are you in trouble? Let us know!