ekalinin / ulauncher-text-expander

Expand Text snippets directly from Ulauncher with Placeholder support.

ulauncher-text-expander

Expand Text snippets directly from Ulauncher with Placeholder support.

Demo

Requirements

• Ulauncher > 5
• Python >= 3

Before installing, make sure to install all the needed Python packages for your system:

pip3 install dateparser glob2 gobject PyGObject

Install

Open ulauncher preferences window -> extensions -> add extension and paste the following url:

https://github.com/brpaz/ulauncher-text-expander

Where:

• name: its an unique identifier for the placeholder. must by unique in the snippet.
• label: A description of the placeholder. This is the label that will appear on the Dialog window to fill in the placeholder values as the description of the placeholder.
• default: A default value of the placeholder

Usage

• For your snippets to be loaded by the extension, place then in .txt files in the snippets directory. By default, the extension will look for files in "~/.config/ulauncher/text-expander/expansions". You can change it the extension settings.
• Type tex in Ulauncher and select the snippet you want to use. It the snippet has any placeholders, a new window will appear where you can fill the values of that placeholders. After that the final snippet with the placeholders filled in will be copied to the clipboard.

Placeholders format

• This extension supports, simple text, select box and date placeholders.

Text input type placeholders

Text input placeholders allows you to ask for simple text values.

You can define input placeholders in your snippet like this:

@input({"name":"hello","label":"This is some placeholder", "default":"Some default value"})

Select type placeholders

Select placeholders allows you to ask for a value from a list of values

You can define input placeholders in your snippet like this:

@select({"name":"hello_s","label":"example select", "options":["option1", "option2"]})

The "name" and "value" is the same of input type. This field have an extra "options" key which contains the list of options that will appear in the select box for this placeholder.

Date placeholders

You can also have placeholders to specify dates. This will be automatically parsed and dont require the user to fill in any value.

The format is the following:

@date(':date_expression'|:date_format)

• The :date_expression can be any format supported by Date Parser python library.
• The date_format can be any format supported by python strftime function.

Examples

@date('now'|%Y-%M-%d) - Render todays date in Year-Month-Day format.

@date('last month'|%B) - Render the name of the last month in the users locale.

@date('in 2 days'|%Y-%m-%d) - Render the date in two days.

@date('10 days ago'|%Y-%m-%d) - Render the date 10 days ago.

Development

make link
make dev

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

💛 Support the project

If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.

The sinplest form of support is to give a ⭐️ to this repo.

You can also contribute with GitHub Sponsors.

Or if you prefer a one time donation to the project, you can simple:

License

Copywright @ 2019 Bruno Paz

This project is MIT Licensed.