uicons.js is a JavaScript class based on the UICONS specification. It provides a simple way to utilize the UICONS standard in your projects and reduces the need for tedious boilerplate code.
npm install uicons.js
yarn add uicons.js
pnpm add uicons.js- File extension agnostic
- Provides helpful IntelliSense in your IDE based on latest protos
- Works in the browser and server
- Supports both remote and local initialization of the index.json file
- View the example code to see implementation details for both audio and image files
- See tests for additional examples.
import { UICONS } from 'uicons.js'
const uicons = new UICONS('https://www.uicons-repo.com')
// Async initialization fetches the index.json file for you
await uicons.remoteInit()
// Sync initialization if you already have contents of the index.json
const indexJson = await fetch('https://www.uicons-repo.com/index.json').then(
(res) => res.json()
)
uicons.init(indexJson)
// Below are some example usages with variable names for demonstration, see intellisense in your IDE for type information
// Please note that in some cases, such as with Stardust, the `reward_id` is the `amount` of the reward
const device = uicons.device(online)
const gym = uicons.gym(team_id, trainer_count, in_battle, ex, ar, power_level)
const invasion = uicons.invasion(grunt_id, confirmed)
const misc = uicons.misc(filename_without_extension)
const nest = uicons.nest(type_id)
const pokemon = uicons.pokemon(
pokemon_id,
evolution_id,
form_id,
costume_id,
gender_id,
alignment_id,
bread_id,
shiny
)
const pokestop = uicons.pokestop(
lure_id,
display,
quest_active,
ar
power,
)
const egg = uicons.raidEgg(raid_level, hatched, ex)
const reward = uicons.reward(reward_type_id, reward_id, amount)
const rewardWithOutId = uicons.reward(reward_type_id, amount)
const spawnpoint = uicons.spawnpoint(has_known_tth)
const team = uicons.team(team_id)
const type = uicons.type(type_id)
const weather = uicons.weather(weather_id, severity, 'day')# Clone Repository
git clone https://github.com/TurtIeSocks/uicons.js.git
cd uicons.js
# Install Dependencies
pnpm run install
# Build and Run Example
pnpm run start
# Run Tests
pnpm run test
