@loomidev/contact-card
v0.3.0
Published
<loomi-contact-card> — a ready-made contact card.
Maintainers
Readme
@loomidev/contact-card
<loomi-contact-card> — a ready-made card for displaying a contact, with avatar, name,
position and contact rows. Saves you from manually building this layout out of
<loomi-card> and <loomi-avatar> every time.
npm install @loomidev/contact-card litimport "@loomidev/contact-card";Basic Usage
A default avatar placeholder is used when image isn't set.
<loomi-contact-card
name="Alex R. Bennett"
position="Senior Developer"
department="Tech"
email="[email protected]"
mobile="+233 123 456 789"
birthday="01 May"
></loomi-contact-card>Custom Image
<loomi-contact-card name="Sara Field" image="/sara.jpg" position="Designer"></loomi-contact-card>When no image is set, initials are derived from name and shown as a label avatar
instead — same fallback behavior as <loomi-avatar>.
Centered Layout
centered reflows the card to stack the avatar above the details, vertically centered
— handy in a grid of team members.
<div style="display:grid;grid-template-columns:repeat(3,1fr);gap:1rem">
<loomi-contact-card name="Alex R. Bennett" position="Senior Developer" centered></loomi-contact-card>
<loomi-contact-card name="Sara Field" image="/sara.jpg" position="Designer" centered></loomi-contact-card>
<loomi-contact-card name="Ada Brooks" position="Product" centered></loomi-contact-card>
</div>Clickable Contact Cards
Same url semantics as <loomi-card> — a path, full URL, or JS function
call.
<loomi-contact-card name="Alex R. Bennett" position="Senior Developer" has-hover url="/team/alex"></loomi-contact-card>Extra Content
The default slot renders below the contact details — useful for tags, a short bio, or action buttons.
<loomi-contact-card name="Alex R. Bennett" position="Senior Developer">
<loomi-tag label="On leave" color="warning"></loomi-tag>
</loomi-contact-card>Card Styling
has-shadow and has-hover work exactly like on <loomi-card>.
<loomi-contact-card name="Alex R. Bennett" has-shadow="false"></loomi-contact-card>Accessibility
For the library-wide baseline, see Foundations — Accessibility.
Responsive behavior
For the shared container and viewport rules, see Foundations — Responsive behavior.
Dark mode
For theme activation, token overrides, and contrast guidance, see Foundations — Dark mode.
Attributes
| Attribute | Default | Description |
| ------------ | --------- | --------------------------------------------- |
| name | (blank) | Contact name (initials avatar when no image). |
| position | (blank) | Job title, shown under the name. |
| department | (blank) | Department, shown under the name. |
| image | (blank) | Avatar image URL. |
| email | (blank) | Email address row, shown with an icon. |
| mobile | (blank) | Phone number row, shown with an icon. |
| birthday | (blank) | Birthday row, shown with an icon. |
| centered | false | Vertically center the layout. (boolean) |
| has-shadow | true | Show a drop shadow. (boolean) |
| has-hover | false | Lift the card on hover. (boolean) |
| url | (blank) | Navigate on click. |
Slots
| Slot | Description | | ----------- | ------------------------------------ | | (default) | Content placed inside the component. |
Full Example
<loomi-contact-card
name="Alex R. Bennett"
position="Senior Copywriter"
department="Tech"
email="[email protected]"
mobile="+233.123.456.789"
birthday="01-May"
has-hover
centered
url="/team/alex"
>
<loomi-tag label="Available" color="success"></loomi-tag>
</loomi-contact-card>Framework integration
<loomi-contact-card> is a standard custom element, so the browser can use it in plain HTML, Blade, React, Vue, Angular, Svelte, Astro, and most other frameworks. The important beginner rule is: install the package, import it once before the tag is rendered, then write the Loomi tag in your template.
Where to run commands
Run install commands from the app where you want to use this component. That means the folder that contains that app's package.json. Do not run these install commands from packages/contact-card unless you are editing LoomiUI itself.
cd /path/to/your-app
npm install @loomidev/contact-card litIf you are contributing to LoomiUI itself, first move to the top-level components folder. That is where the main package.json for all packages lives, and pnpm --filter ... commands should be run from there:
cd /path/to/your-copy-of-loomiui/components
pnpm --filter @loomidev/contact-card build
pnpm --filter @loomidev/contact-card typecheckChoose your framework
Use the CDN version for prototypes, documentation pages, or a quick reproduction. The import map tells the browser where to find Lit, which Loomi components use internally.
<script type="importmap">
{ "imports": { "lit": "https://esm.sh/[email protected]", "lit/": "https://esm.sh/[email protected]/" } }
</script>
<script type="module" src="https://esm.sh/@loomidev/contact-card"></script>
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>In Vite, Webpack, Parcel, Rollup, or a framework build pipeline, install the package and import it once in your main app JavaScript file. After that, you can use the Loomi tag anywhere in your app.
import "@loomidev/contact-card";Run the install command from your Laravel project root, then import the component in resources/js/app.js. If your project uses Laravel Vite, npm run dev and npm run build should also be run from the Laravel project root.
cd /path/to/your-laravel-app
npm install @loomidev/contact-card lit
npm run dev// resources/js/app.js
import "@loomidev/contact-card";<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>React can render Loomi tags directly. If you are on React 18, or if you need to pass arrays, objects, or functions, use a ref and assign those values after the component mounts.
import "@loomidev/contact-card";
export function LoomiExample() {
return (
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>
);
}If TypeScript does not recognize the Loomi tag in JSX, add it to your app's JSX type declarations.
Import the package in the component that uses it, or once in your main Vue file. Vue templates can use Loomi tags directly. For arrays, objects, or functions, pass the value as a JavaScript property instead of as plain text.
<script setup>
import "@loomidev/contact-card";
</script>
<template>
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>
</template>If Vue warns that the tag is an unknown component, configure compilerOptions.isCustomElement for tags that start with loomi- in your Vite or Vue config.
Import the package once and tell Angular to allow custom HTML tags with CUSTOM_ELEMENTS_SCHEMA. For NgModule apps, add the schema to the module instead of the standalone component.
// app.component.ts
import { CUSTOM_ELEMENTS_SCHEMA, Component } from "@angular/core";
import "@loomidev/contact-card";
@Component({
selector: "app-root",
standalone: true,
schemas: [CUSTOM_ELEMENTS_SCHEMA],
template: `
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>
`,
})
export class AppComponent {}Svelte can import the package inside a component script. Astro can import it in the frontmatter of the page or layout where the tag appears.
<script>
import "@loomidev/contact-card";
</script>
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>---
import "@loomidev/contact-card";
---
<loomi-contact-card
name="Emma Miller"
position="Product Manager"
department="Growth"
email="[email protected]"
></loomi-contact-card>Server-side rendering notes
Frameworks such as Next.js, Nuxt, SvelteKit, and Astro sometimes render HTML on the server before browser-only code runs. If your framework complains, move the Loomi import to client-side code. In Next.js, that usually means a component with "use client"; in Nuxt, it often means a .client.ts plugin.
Dependencies
@loomidev/card@loomidev/core@loomidev/icons
