vCard generator plugin for Craft cms 3
This plugin requires Craft CMS 3.0.0-RC1 or later.
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project -
Then tell Composer to load the plugin:
composer require nfourtythree/vcard -
In the Control Panel, go to Settings → Plugins and click the “Install” button for vCard.
This plugin generates a link to download a vCard from data you specify
There is only one setting for this plugin which is salt this is a string used for salting the encoded data when generating the vCard link.
This can be set by creating a vcard.php config file in the config/ directory. Please copy the config.php in the plugin for the correct layout.
The only thing that is really required is first name. Everything else is optional
There is a link variable available for usage in templates craft.vCard.link(options)
{% set options = {
firstName: "Johnny",
lastName: "Appleseed",
additional: "Jim",
prefix: "Mr",
suffix: "Esq",
company: "Apple Inc.",
jobTitle: "Data Demo",
email: [{ address: "[email protected]", type: "WORK" }, "[email protected]"],
url: "http://apple.com",
phoneNumber: ["+1 234 567 89", { number: "+9 876 543 21"}],
photo: "http://exmaple.com/images/avatar.jpg",
address: [{
name: "Apple",
extended: "Suite 1",
street: "1 Infinte Loop",
city: "Cupertino",
region: "CA",
zip: "95014",
country: "USA",
type: "WORK;PARCEL;POSTAL"
},
{
street: "1 Yemen Road",
zip: "1234",
country: "Yemen",
type: "HOME;POSTAL"
}],
note: "Hi there",
} %}
<a href="{{ craft.vCard.link(options) }}">Download my vCard</a>
| Name | Type | Example |
|---|---|---|
| firstName | String | Johnny |
| lastName | String | Appleseed |
| additional | String | Jim (commonly a middle name) |
| prefix | String | Mr |
| suffix | String | Esq |
| company | String | Apple Inc |
| jobTitle | String | Demo Data Guru |
| String | Array | See email docs | |
| url | String | Array | See url docs |
| address | String | Array | See address docs |
| phoneNumber | String | Array | See phoneNumber docs |
| birthday | String | 1985-10-26 (YYYY-MM-DD format) |
| note | String | Johnny is amazing |
| photo | String | http://example.com/images/avatar.jpg (Url to image) |
This can be specified as either a string [email protected] or an array (or even a mix!)
| Name | Type | Example |
|---|---|---|
| address | String | [email protected] |
| type | String | type may be PREF |
email: {
address: "[email protected]",
type: "WORK"
}
// For multiple email addresses
email: [{
address: "[email protected]",
type: "WORK"
},
{
address: "[email protected]",
type: "PREF;HOME"
}]
// Mix and match example
email: ["[email protected]", {
address: "[email protected]",
type: "PREF;HOME"
}]
This can be specified as either a string http://apple.com or an array (or even a mix!)
| Name | Type | Example |
|---|---|---|
| address | String | http://apple.com |
| type | String | type may be WORK |
url: {
address: "http://apple.com",
type: "WORK"
}
// For multiple urls
url: [{
address: "http://apple.com",
type: "WORK"
},
{
address: "http://google.com",
type: "HOME"
}]
// Mix and match example
url: ["http://apple.com", {
address: "http://google.com",
type: "HOME"
}]
This can be specified as either a string +1 234 567 89 or an array (or even a mix!)
| Name | Type | Example |
|---|---|---|
| number | String | +1 234 567 89 |
| type | String | Type may be PREF |
phoneNumber: {
number: "+1 234 567 89",
type: "PREF;WORK;VOICE"
}
// For multiple phoneNumbers
phoneNumber: [{
number: "+1 234 567 89",
type: "WORK"
},
{
number: "+9 876 543 21",
type: "PREF;HOME"
}]
// Mix and match example
phoneNumber: ["+1 234 567 89", {
number: "+9 876 543 21",
type: "HOME"
}]
This can be either a single or multi array
| Name | Type | Example |
|---|---|---|
| name | String | Apple |
| extended | String | Suite 1 |
| street | String | 1 Infinte Loop |
| city | String | Cupertino |
| region | String | CA |
| zip | String | 95014 |
| country | String | USA |
| type | String | type may be DOM |
address: {
name: "Apple",
extended: "Suite 1",
street: "1 Infinte Loop",
city: "Cupertino",
region: "CA",
zip: "95014",
country: "USA",
type: "WORK;PARCEL;POSTAL"
}
// For multiple addresses
address: [{
name: "Apple",
extended: "Suite 1",
street: "1 Infinte Loop",
city: "Cupertino",
region: "CA",
zip: "95014",
country: "USA",
type: "WORK;PARCEL;POSTAL"
},
{
street: "1 Yemen Road",
zip: "1234",
country: "Yemen",
type: "HOME;POSTAL"
}]
- Clean up / refactor code to tidy code that was done quickly
Brought to you by Nathaniel Hammond (nfourtythree)
- Jeroen Desloovere - https://github.com/jeroendesloovere/vcard
- nystudio107 - https://github.com/nystudio107/generator-craftplugin (for just making life easier / quicker)
- Chris Rowe - http://chrisrowe.net for the idea to make this plugin
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
