Skip to content

Latest commit

 

History

History
173 lines (125 loc) · 5.97 KB

README.md

File metadata and controls

173 lines (125 loc) · 5.97 KB
Raw

Digital Business Card Web Component

License: MIT maintained with hearth by skullzarmy

A customizable web component for generating digital business cards. Easily embed a business card into your web page with various themes and font variants. This component is lightweight, easy to use, and fully customizable.

Jane Doe dark serif example business card

John Doe light sans example business card

Table of Contents

Features

  • Customizable: Easily change the card's appearance with attributes.
  • Themes: Light and dark themes available.
  • Font Variants: Choose from a variety of font styles.
  • QR Code: Automatically generates a QR code for contact information.
  • Self-contained: No need for external image files; supports Base64 encoded images.

Getting Started

To get started, include the following script tag in your HTML file:

<script src="https://skullzarmy.github.io/digital-business-cards/digital-business-cards.js"></script>

Prerequisites

No prerequisites are required. The component dynamically loads all necessary resources.

Installation

Simply include the script in your HTML file, and you're good to go!

<script src="https://skullzarmy.github.io/digital-business-cards/digital-business-cards.js"></script>

Usage

Here's a simple example to embed a digital business card into your web page:

<digital-business-card
    name="John Doe"
    email="[email protected]"
    phone="(555) 555-5555"
    website="https://example.org"
    address="1234 Main St. City ST 001100"
    socialMedia='[{"platform": "facebook", "url": "https://facebook.com/johndoe"}, {"platform": "twitter", "url": "https://twitter.com/johndoe"}, {"platform": "mastodon", "url": "https://mastodon.social/johndoe"}]'
    theme="dark"
    fontVariant="sans"
    imageSrc="data:image/webp;base64,..."
>
</digital-business-card>

View all variants on the examples page

Generator

You can utilize my generator tool to setup this Web Component with your information. It will automatically encode your image in base64 for portability! Check it out on my blog, https://SoCalTechLab.com/utils/digital-business-card-generator/

Attributes

  • name: The name to display on the card.
  • email: The email address. Builds mailto link.
  • phone: The phone number. Builds tel link.
  • website: The website URL. Builds standard href link.
  • address: The physical address. Builds link to Google Maps.
  • socialMedia: An array of objects, each containing a platform and a url. The platform should match one of the supported social media platforms, and url should be the full URL to your profile on that platform.
  • theme: The theme of the card (light or dark).
  • fontVariant: The font variant (sans, serif, handwritten, gothic).
  • imageSrc: The source for the profile image (supports Base64 and image URLs).
  • imageShape: The shape of the image (circle or square).

Theming

Themes

  • light: Light background with dark text.
  • dark: Dark background with light text.

Font Variants

  • sans: Sans-serif font.
  • serif: Serif font.
  • script: Handwritten-style font.
  • display: Display-style font.

Social Media Platforms

The following platforms are supported (icons are predefined):

icons are from simpleicons.org

  • Facebook
  • Twitter
  • LinkedIn
  • Mastodon
  • GitHub
  • GitLab
  • Bitbucket
  • Stack Overflow
  • YouTube
  • Instagram
  • Pinterest
  • Snapchat
  • Reddit
  • Tumblr
  • Twitch
  • Discord

I will accept requests for new icons. Just open an issue on Github. Please provide a link to the icon on simpleicons.org or provide a source for an SVG file with an open license. If it fits the aesthetic of the rest of the icons I will include.

To specify social media links, use the socialMedia attribute with an array of objects. Each object should have a platform and a url. For example:

[
    { "platform": "facebook", "url": "https://facebook.com/johndoe" },
    { "platform": "twitter", "url": "https://twitter.com/johndoe" },
    { "platform": "mastodon", "url": "https://mastodon.social/johndoe" }
]

QR Code

The component automatically generates a QR code based on the provided contact information. Users can scan OR click the QR code to save the contact information to their device via standard vCard v3.0 formatting.

Roadmap

  1. Add support for all standard social media links with logos from simple-icons
  2. Add support for any Google font by name
    • Progress made on refactoring the font loading to load only needed font.
  3. Add custom theme color support
  4. Add custom base font size support
  5. Create component generator

Contributing

Contributions are welcome! Please read the contributing guidelines first.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

Acknowledgments

  • Google Fonts for providing the font styles.
  • QRCode.js for generating QR codes.
  • SimpleIcons.org for providing free and open SVG icons