nerdbar.widget 项目使用教程

nerdbar.widget 项目使用教程

nerdbar.widgetÜbersicht system information bar for use with kwm window manager (or without).项目地址:https://gitcode.com/gh_mirrors/ne/nerdbar.widget

1. 项目的目录结构及介绍

nerdbar.widget 项目的目录结构如下：

nerdbar.widget/
├── README.md
├── bar.coffee
├── css
│   └── bar.css
├── scripts
│   ├── active-space.sh
│   ├── battery.sh
│   ├── cpu.sh
│   ├── focused-window.sh
│   ├── mem.sh
│   ├── now-playing.sh
│   ├── space.sh
│   └── time.sh
└── widgets
    ├── active-space.coffee
    ├── battery.coffee
    ├── cpu.coffee
    ├── focused-window.coffee
    ├── mem.coffee
    ├── now-playing.coffee
    ├── space.coffee
    └── time.coffee

目录介绍

• README.md: 项目说明文件，包含项目的基本信息和使用方法。
• bar.coffee: 主启动文件，负责加载和显示各个小部件。
• css/: 存放样式文件的目录。
  • bar.css: 主样式文件，定义了小部件的外观和布局。
• scripts/: 存放脚本的目录，这些脚本负责获取系统信息并传递给小部件。
  • active-space.sh: 获取当前活动空间信息。
  • battery.sh: 获取电池信息。
  • cpu.sh: 获取CPU使用信息。
  • focused-window.sh: 获取当前聚焦窗口信息。
  • mem.sh: 获取内存使用信息。
  • now-playing.sh: 获取当前播放的歌曲信息。
  • space.sh: 获取空间信息。
  • time.sh: 获取时间信息。
• widgets/: 存放小部件的目录，这些小部件负责显示具体的信息。
  • active-space.coffee: 显示活动空间信息的小部件。
  • battery.coffee: 显示电池信息的小部件。
  • cpu.coffee: 显示CPU使用信息的小部件。
  • focused-window.coffee: 显示当前聚焦窗口信息的小部件。
  • mem.coffee: 显示内存使用信息的小部件。
  • now-playing.coffee: 显示当前播放歌曲信息的小部件。
  • space.coffee: 显示空间信息的小部件。
  • time.coffee: 显示时间信息的小部件。

2. 项目的启动文件介绍

项目的启动文件是 bar.coffee，它负责加载和显示各个小部件。以下是 bar.coffee 的主要内容：

# 导入必要的模块
os = require 'os'
fs = require 'fs'
path = require 'path'

# 定义小部件的路径
widgetPath = path.join __dirname, 'widgets'

# 加载所有小部件
fs.readdir widgetPath, (err, files) ->
    if err
        console.error "无法读取小部件目录: #{err}"
        return

    for file in files
        if file.endsWith '.coffee'
            require path.join widgetPath, file

启动文件介绍

• bar.coffee 使用 Node.js 的 os, fs, 和 path 模块来处理文件和路径操作。
• 它读取 widgets 目录下的所有 .coffee 文件，并加载这些文件作为小部件。

3. 项目的配置文件介绍

nerdbar.widget 项目的配置文件主要是 bar.coffee 和各个小部件的 .coffee 文件。以下是 bar.coffee 和一个小部件 battery.coffee 的配置示例：

bar.coffee 配置示例

# 定义小部件的显示位置和样式
widget.position = 'top'
widget.style = fs.readFileSync path.join(__dirname, 'css', 'bar.css'), 'utf-8'

battery.coffee 配置示例

# 定义电池小部件的显示内容和样式
widget.text = ->
    "#{scripts.battery.percentage}%"

widget.style = '''
    color: #fff;
    background: #333;
    padding: 5px;
'''

nerdbar.widgetÜbersicht system information bar for use with kwm window manager (or without).项目地址:https://gitcode.com/gh_mirrors/ne/nerdbar.widget