pf-profilecard

3.0.3 • Public • Published

AtlasKit component registry Commitizen friendly semantic-release Report an issue Ask in our forum

Profilecard

Example profilecard

Installation

npm install pf-profilecard

Using the component

HTML

The pf-profilecard package exports the ProfileCard Skate component.

Import the component in your JS resource:

bundle.js

import 'pf-profilecard';

Now you can use the defined tag in our HTML markup, e.g.:

index.html

<html>
<head>
  <script src="bundle.js"></script> 
</head>
<body>
  <!-- ... -->
  <pf-profilecard></pf-profilecard>
</body>

or from within another JavaScript resource:

import ProfileCard from 'pf-profilecard';
 
const component = new ProfileCard();
document.body.appendChild(component);

React

import ProfileCard from 'pf-profilecard';
import reactify from 'skatejs-react-integration';
 
const ReactComponent = reactify(ProfileCard, {});
 
ReactDOM.render(<ReactComponent />, container);

Classes

ProfilecardResourced
Profilecard

ProfilecardResourced

Kind: global class

new ProfilecardResourced()

Create instances of the component programmatically, or using markup.

HTML Example

<pf-profilecard-resourced/></pf-profilecard-resourced>

JS Example

import ProfilecardResourced from 'pf-profilecard';
const component = new ProfilecardResourced();

profilecardResourced.ProfilecardResourceddata-account-id : string

Kind: instance property of ProfilecardResourced

profilecardResourced.ProfilecardResourceddata-cloud-id : 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 event keys. label defines the button text while event is returned as detail in the emitted action event in case the button is clicked. [Will be passed to ProfileCard]

Kind: instance property of ProfilecardResourced
Example

[{label: 'Chat', event: 'ev_chat'}, {label: 'View', event: 'ev_view'}]

profilecardResourced.use24h : boolean

Use 24h clock instead of the default 12h clock. [Will be passed to ProfileCard]

Kind: instance property of ProfilecardResourced

Profilecard

Kind: global class

new Profilecard()

Definition of the Profilecard component.

HTML Example

<pf-profilecard></pf-profilecard>

JS Example

import Profilecard from 'pf-profilecard';
const myProfilecard = new Profilecard();

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.timestamp : number

Kind: instance property of Profilecard

profilecard.location : string

Kind: instance property of Profilecard

profilecard.presence : string

Kind: instance property of Profilecard

profilecard.actions : array

Defining the action buttons on the card. Array of one or more action objects with label and event keys. label defines the button text while event is returned as detail in the emitted action event in case the button is clicked.

Kind: instance property of Profilecard
Example

[{label: 'Chat', event: 'ev_chat'}, {label: 'View', event: 'ev_view'}]

profilecard.use24h : boolean

Use 24h clock instead of the default 12h clock.

Kind: instance property of Profilecard

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!

Readme

Keywords

Package Sidebar

Install

npm i pf-profilecard

Weekly Downloads

0

Version

3.0.3

License

Apache-2.0

Last publish

Collaborators

  • atlassian-aui