Pengantar
Kubai Icons adalah pustaka sumber terbuka berisi ikon SVG berlapis dengan gerakan hover. Halaman ini mencantumkan paket dan menjelaskan cara ikon diberi nama dan diberi versi.
Setiap ikon mengambil semua warnanya dari satu warna aksen. Saat di-hover, ikon memperagakan apa yang dilakukan objeknya: folder terbuka, amplop dibuka segelnya. Setiap ikon adalah modul ES terpisah yang menyimpan markup SVG kondisi diamnya, yang disebut pose diam, dan gerakan hover-nya.
Paket
| Paket | Kegunaan | Dokumen |
|---|---|---|
kubai-icons-react | React 18+ dan Next.js, termasuk render di server | Paket React |
kubai-icons-vue | Vue 3.3+ dan Nuxt | Paket Vue |
kubai-icons | JavaScript biasa dan web component <kubai-icon> | Paket JavaScript |
kubai-icons-static | File SVG untuk tag <img>, alat desain, dan halaman tanpa JavaScript | Paket SVG statis |
Mulai cepat
Contoh ini memakai React. Untuk lingkungan lain, lihat paket yang tercantum di atas. Pasang paketnya:
npm install kubai-icons-reactLalu impor ikon yang Anda perlukan:
import { Folder, MailPlus } from "kubai-icons-react";
export default function App() {
return (
<>
<Folder /> {/* 24px, in the text color */}
<MailPlus size={32} color="#EC4899" /> {/* any CSS color */}
</>
);
}Nama ikon
Nama ikon berbahasa Inggris dan berformat kebab-case: folder, cloud-rain, arrow-up-right. Paket JavaScript, React, dan Vue mengekspornya dalam PascalCase, seperti CloudRain. React dan Vue juga mengekspor CloudRainIcon. File statis tetap memakai nama kebab-case. Penjelajah ikon mencari nama dan tag.
Banyak ikon dasar juga tersedia sebagai ikon berlencana, seperti folder-plus, user-check, dan calendar-clock. Ikon untuk hal yang dapat dimatikan juga tersedia sebagai ikon bergaris coret, seperti bell-off.
Pemberian versi
Paket mengikuti semantic versioning dan dirilis bersamaan. Mengganti nama atau menghapus ikon adalah perubahan yang merusak (breaking change); menggambar ulang ikon bukan. Catatan rilis diterbitkan di GitHub.