نام (NAME)

waybar-keyboard-state - ماژول وضعیت صفحه‌کلید برای waybar

توضیحات (DESCRIPTION)

ماژول keyboard-state وضعیت کلیدهای قفل اعداد (Num Lock)، قفل حروف بزرگ (Caps Lock) و قفل پیمایش (Scroll Lock) را نمایش می‌دهد.

برای استفاده از این ماژول باید عضو گروه input باشید.

پیکربندی (CONFIGURATION)

interval:
منسوخ شده؛ این ماژول اکنون از حلقه رویداد (event loop) استفاده می‌کند و بازه زمانی تاثیری ندارد.

format:
نوع: string|object
پیش‌فرض: {name} {icon}
قالب نحوه نمایش اطلاعات. اگر از نوع رشته باشد، قالب یکسانی برای تمام وضعیت‌های صفحه‌کلید استفاده می‌شود. اگر از نوع شیء باشد، فیلدهای «numlock»، «capslock» و «scrolllock» هر کدام قالب متناظر با آن وضعیت را مشخص می‌کنند. هر وضعیتی که مشخص نشده باشد از قالب پیش‌فرض استفاده خواهد کرد.

format-icons:
نوع: object
پیش‌فرض: {"locked": "locked", "unlocked": "unlocked"}
بر اساس وضعیت صفحه‌کلید، آیکون متناظر انتخاب می‌شود. مجموعه آیکون‌های یکسانی برای قفل اعداد، حروف بزرگ و پیمایش استفاده می‌شود، اما آیکون از میان این مجموعه به‌طور مستقل برای هر یک انتخاب می‌گردد. بخش آیکون‌ها (ICONS) را ببینید.

numlock:
نوع: bool
پیش‌فرض: false
نمایش وضعیت قفل اعداد (Num Lock).

capslock:
نوع: bool
پیش‌فرض: false
نمایش وضعیت قفل حروف بزرگ (Caps Lock).

scrolllock:
نوع: bool
پیش‌فرض: false
نمایش وضعیت قفل پیمایش (Scroll Lock).

device-path:
نوع: string
پیش‌فرض: اولین دستگاه ورودی معتبر را انتخاب می‌کند
مشخص می‌کند وضعیت کدام دستگاه ورودی libevdev نمایش داده شود. دستگاه‌های libevdev را می‌توان در dev/input/ یافت. دستگاه باید از رویدادهای قفل اعداد، قفل حروف بزرگ و قفل پیمایش پشتیبانی کند.

binding-keys:
نوع: array
پیش‌فرض: [58, 69, 70]
شخصی‌سازی کلید راه‌انداز این ماژول؛ شماره کلید را می‌توان در usr/include/linux/input-event-codes.h/ یا با اجرای دستور sudo libinput debug-events --show-keycodes پیدا کرد.

expand:
نوع: bool
پیش‌فرض: false
به این ماژول امکان می‌دهد تمام فضای باقی‌مانده را به‌طور پویا مصرف کند.

جایگزین‌های قالب‌بندی (FORMAT REPLACEMENTS)

{name}: Caps، Num یا Scroll.

{icon}: آیکون، طبق تعریف در format-icons.

آیکون‌ها (ICONS)

موارد زیر در format-icons قابل تنظیم هستند.

• locked: زمانی که وضعیت صفحه‌کلید قفل باشد نمایش داده می‌شود. پیش‌فرض "locked".
• unlocked: زمانی که وضعیت صفحه‌کلید قفل نباشد نمایش داده می‌شود. پیش‌فرض "unlocked"

مثال (EXAMPLE)

"keyboard-state": {
	"numlock": true,
	"capslock": true,
	"format": "{name} {icon}",
	"format-icons": {
		"locked": "",
		"unlocked": ""
	}
}

شیوه‌نامه (STYLE)

• #keyboard-state
• #keyboard-state label
• #keyboard-state label.locked
• #keyboard-state label.numlock
• #keyboard-state label.numlock.locked
• #keyboard-state label.capslock
• #keyboard-state label.capslock.locked
• #keyboard-state label.scrolllock
• #keyboard-state label.scrolllock.locked