armory-embeds
v0.4.3
Guild Wars 2 Armory Embeds
0/weekUpdated 3 years agoUnpacked: 9.2 MB
Published by madou
npm install armory-embedsarmory-embeds
Guild Wars 2 Armory is arming the GW2 community with powered up embeds for items,
skills,
and more.
Want something more low level? Want to integrate directly with your React app instead of this high level abstraction?
Check out the armory-ui-components library.
Usage
First add the embeds to your html:
``html`
Then add the embed script after them:
`html`
When the document has fully loaded the embeds will then be loaded.
Note the semvar range. When breaking changes are introduced, this will be incremented by one every time. For example from @^0.x.x to @^1.x.x.
Supplementary Libraries
- armory-embeds-chat-codes - parses an ingame chat code to armory embed markup.
Options
$3
Entirely optional.
Create an object on the document object named GW2A_EMBED_OPTIONS. See below for an example.gw2a
Make sure the assign this config _before_ declaring the script.
| prop | type | required | description |
|-|-|-|-|
| lang | string | no | The language the embeds will be loaded in. Supported values are: en, fr, de, es, zh, ru |
| persistToLocalStorage | boolean | no | Turns data persistence on or off. Default to true. |
| forceCacheClearOnNextRun | string | no | Forces data cache to be cleared. Use wisely. Use a unique key every time you want to clear the cache. |
`javascript`
document.GW2A_EMBED_OPTIONS = {
lang: 'en',
persistToLocalStorage: true,
forceCacheClearOnNextRun: '1',
};
$3
Each embed has a class that you can target, each class follows the pattern .gw2a-{EMBED_NAME}-embed.
`css`
.gw2a-character-embed {}
.gw2a-skills-embed {}
.gw2a-items-embed {}
.gw2a-amulets-embed {}
.gw2a-traits-embed {}
.gw2a-specializations-embed {}
Embeds
$3
`html
data-armory-ids="5507,5508,5510,5515">
data-armory-ids="5508,332211,5510,-1"
data-armory-size="40"
data-armory-blank-text="This can be replaced with any text!"
>
`
| attribute | value | required | description |
|-|-|-|-|
| data-armory-embed | skills | yes | |
| data-armory-ids | numbers delimited by commas | yes | The skill ids you want to load. If you pass
you will load an empty box instead of the skill. |
| data-armory-size | number | no | The size of each skill in the embed. |
| data-armory-blank-text | string | no | When loading an skill of id -1 you can override the tooltip text to be whatever you want. |
| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in wiki to use a gw2 wiki URL, or pass in any other text that will be used as the link. |$3
`html
data-armory-blank-text="Some other text can go here!"
data-armory-size="60"
data-armory-ids="24836,-1,74412,46774,39620,1379"
data-armory-1379-upgrades="24615,24815"
data-armory-1379-upgrade-count="{\"24815\": 3}"
data-armory-1379-infusions="49426,49426"
>
data-armory-ids="77482"
data-armory-77482-stat="656"
>
`
| attribute | value | required | description |
|-|-|-|-|
| data-armory-embed | items | yes | |
| data-armory-ids | numbers delimited by commas | yes | The item ids you want to load. If you pass
you will load an empty box instead of the item. |
| data-armory-size | number | no | The size of each item in the embed. |
| data-armory-blank-text | string | no | When loading an item of id -1 you can override the tooltip text to be whatever you want. |
| data-armory-{ITEM_ID}-stat | number | no | Loads the item with the stat of choice. |
| data-armory-{ITEM_ID}-skin | number | no | Loads the item with the skin of choice. |
| data-armory-{ITEM_ID}-upgrades | number | no | Loads the item with the upgrades of choice. |
| data-armory-{ITEM_ID}-infusions | number | no | Loads the item with the infusions of choice. |
| data-armory-{ITEM_ID}-upgrade-count | stringified { [number]: number } | no | Sets the upgrade counts. |
| data-armory-inline-text | string | no | Optional inline text that will be displayed to the right of the icon. You can pass in wiki to use a gw2 wiki URL, gw2spidy to use a gw2spidy URL, or pass in any other text that will be used as the link. |$3
`html
data-armory-ids="3,332211"
data-armory-3-traits="1761,1774,1749"
>
`
| attribute | value | required | description |
|-|-|-|-|
| data-armory-embed | specializations | yes | |
| data-armory-ids | numbers delimited by commas | yes | The specialization ids you want to load. |
| data-armory-{SPEC_ID}-traits | numbers delimited by commas | no | Traits you want to select for the specialization. Entirely optional, you can select any combination. |
$3
html
data-armory-ids="820,-1,1694"
data-armory-blank-text="This could be anything you want!"
>
