https://github.com/thecommieaxolotl/lumin
lumin is a highly adaptive Übersicht widget inspired by rofi.
https://github.com/thecommieaxolotl/lumin
Last synced: 3 months ago
JSON representation
lumin is a highly adaptive Übersicht widget inspired by rofi.
- Host: GitHub
- URL: https://github.com/thecommieaxolotl/lumin
- Owner: TheCommieAxolotl
- Created: 2022-08-22T00:12:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T02:10:33.000Z (almost 3 years ago)
- Last Synced: 2025-01-16T10:36:06.069Z (5 months ago)
- Language: JavaScript
- Size: 8.3 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# lumin
Have you ever looked at screenshots from those linux users sharing their precious rices and been a teeny bit jealous? Well lumin will help you get some of that unix-y look.
## So umm... what it is?
lumin is an [Übersicht](https://github.com/felixhageloh/uebersicht) widget inspired by [rofi](https://github.com/davatorium/rofi). It can mimic anything from a powermenu to an app launcher. You can customise lumin to your endless desire with styling and buttons.
## Installation
You can either git clone the repository or download the zip file and install it manually.
```bash
$ git clone https://github.com/TheCommieAxolotl/lumin.git
```
## Usage
move the downloaded folder to your Übersicht folder.
**Ta Da ✨, you now have lumin on your desktop**
## Customisation and Configuration
### Styling
lumin is extremely configurable, within `core.jsx` you will see the `config` object. this object contains all the styling that you can configure.
### Image
To customise the image, you can edit or replace the `images/main.png` file.
### Buttons
You can add/remove/edit the buttons and their icons and text by editing the initial state or direct children of the `Button` elements
```jsx
// you can either use the initialState
export const initialState = {text: "text" }
export const render = ({text}) => {
{text}
}
// or you can use the direct children of the Button element
export const render = () => {
text
}
```
Buttons can do anything on [almost any React event](https://reactjs.org/docs/events.html#supported-events).
```jsx
import { run } from "uebersicht";
// run a bash command
{
run("echo 'Hello World'")
}}>click me!
```
#### For some examples and previews of lumin, have a look in the `assets` directory.