hsds react

HSD: Bereaksi

Komponen Bereaksi Untuk Sistem Desain Bantuan Scout

Demo langsung

Lihat buku cerita HSDS: https://hsds.helpscout.com/.

Memasang

 npm install @helpscout/hsds-react --save

Memulai

Setelah mengkloning repo ini, jalankan:

 npm install

Setelah semuanya diinstal, jalankan:

 npm start

Lihat buku cerita HSDS di http: // localhost: 8900/di browser Anda!

Adaptor SVG

Pada v2.18.0, set svg adalah opt-in. Ini dilakukan untuk mengurangi ukuran bundel yang dikompilasi. Untuk memuat ikon svg , tambahkan adaptor yang sesuai ke aplikasi Anda.

Disarankan agar adaptor dimuat di suatu tempat dalam titik masuk utama Anda (misalnya src/index.js ).

 // src/index.js
// For a lighter-weight svg set for embeddables
import '@helpscout/hsds-react/adapters/embed'
// For the complete svg set
import '@helpscout/hsds-react/adapters/app'

Catatan: Ini memuat semua gambar svg , termasuk Icon dan Illo .

Pengujian

Untuk menjalankan Jest in Watch Mode, jalankan:

 npm run dev

Untuk menjalankan semua tes (dengan pelaporan cakupan), jalankan:

 npm run test

Penerbitan

Menggabungkan pr

Untuk menggabungkan PR ketika rilis selesai, silakan lakukan squash dan gabungkan dari halaman PR. Itu akan menjaga sejarah tetap bersih di cabang utama

Kami cenderung melakukan rilis dengan hanya satu PR pada saat itu, jika memungkinkan

Melepaskan di NPM

Anda dapat mempelajari lebih lanjut tentang merilis utama atau melepaskan beta build

Untuk menerbitkan dan merilis versi baru HSDS, jalankan perintah berikut:

 npm run release

Anda akan disajikan dengan prompt CLI dengan opsi. Pilih yang Anda inginkan, dan hanya itu! Script akan mengurus sisanya (dari pengujian hingga penerbitan).

Menyebarkan buku cerita

Untuk menggunakan buku cerita, jalankan perintah berikut:

 npm run deploy

Sedang belajar

• Dokumentasi HSDS: https://hsds.helpscout.com/
• Dokumentasi mendalam pengembang: dev docs
• Juga, lihat video kami untuk lebih banyak sumber belajar

Biru?

Pada 8 Nov 2018, kami mengganti nama Blue ke HSDS: React ?.

Perpustakaan biru asli masih akan ada di NPM, dan masih dapat diinstal melalui:

 npm install @helpscout/blue --save

Namun, pengembangan berkelanjutan dari pustaka komponen ini akan berlanjut di bawah HSDS: React, yang dapat diinstal melalui:

 npm install @helpscout/hsds-react --save

Terima kasih banyak untuk semua orang yang terlibat dalam warna biru! Biru akan selalu menjadi anak laki -laki Anda? .