Skip to content

کتابخانه متن و فونت قرآن (text) ​

هدف این پکیج ارائه‌ی متن و فونت قرآن است.

نصب ​

جهت نصب این کتابخانه از دستور زیر استفاده کنید:

bash
npm i @ghoran/text

استفاده از متن خام ​

اگر نمی‌خواهید وارد ساز و کار ابزارهای بیلد جاوااسکریپتی شوید و تنها می‌خواهید از متن آماده‌شده‌ی نهایی استفاده کنید، این متن‌ها را در لینک زیر می‌توانید ببینید:

https://unpkg.com/browse/@ghoran/text@latest/json/

استفاده از متن قرآن ​

متن قرآن در رسم الخط‌های مختلف ارائه شده است:

  • tanzil-simple-clean: متن بدون علامت، مناسب برای جستجو در متن قرآن.
  • tanzil-simple-min: متن کم علامت، برای کپی و اشتراک گذاری در برنامه‌های مختلف.
  • imla: رسم الاملاء.
  • hafs: رسم الخط عثمان طه اصلی (حفص) - باید با فونت مربوطه استفاده شود.
  • hafs-v13: رسم الخط عثمان طه اصلی (حفص) نسخه قدیمی - باید با فونت مربوطه استفاده شود.

برای توضیح بیشتر در مورد کاربرد رسم‌الخط‌های مختلف به بخش رسم‌الخط و فونت مراجعه کنید.

نمونه استفاده از متن قرآن:

js
import { loadText } from '@ghoran/text'

// خروجی این تابع آرایه ای کامل از تمام آیات قرآن است
// برای تفکیک آن بر اساس صفحه یا سوره یا... از پکیج metadata استفاده کمک بگیرید.
const quranText = await loadText('hafs')

نکته

برای پرفرمنس بهتر این کتابخانه به صورت lazy آرایه‌ی مربوط به رسم الخط انتخاب‌شده را بر می‌گرداند.

استفاده از فونت قرآن ​

در حال حاضر فونت‌های زیر در این کتابخانه ارائه شده است:

  • uthmanic-hafs: فونت عثمان طه واقعی (همراه فونت hafs باید به کار برود).
  • uthmanic-hafs-v13: نسخه قدیمی‌تر فونت عثمان‌طه که شامل وزن درشت نیز هست (همراه فونت hafs-v13 باید به کار برود).

نمونه تعریف و استفاده از این فونت‌ها:

js
import '@ghoran/text/fonts/uthmanic-hafs-v13/style.css'
html
<div class="text-uthmanic-hafs-v13">...</div>