/FlowPlugin-ts

A package to help you create plugins for Flow Launcher with Typescript

Primary LanguageTypeScriptMIT LicenseMIT

Flow Launcher - Plugin Helper

NPM package GitHub repository

A package to help you create plugins for Flow Launcher with Typescript

Getting Started

Flow Launcher is a productivity tool for Windows that allows you to quickly launch applications, search files and folders, and perform web searches. With Flow Launcher, you can create your own plugins to extend its functionality and customize it to your needs.

You can learn more about Flow Launcher.

Installation

npm install flow-plugin

Usage

Here's a simple example of how to use this package, and just like that you can create your own plugin for Flow Launcher.

Add Flow Launcher's results by using the add method, and listen for queries with the on method.

It provides an easy-to-use API to create your plugin, and it also provides a type definition file to help you develop your plugin.

import Flow from 'flow-plugin';

const flow = new Flow();

flow.add({
  title: 'Welcome to Flow!',
  subtitle: 'Create your own plugin with Typescript!',
  icoPath: 'app.png',
});

flow.on('query', (request, response) => {
  const query = request.parameters[0];

  response.add({
    title: 'Hello World!',
    subtitle: `You searched for "${query}"`,
    icoPath: 'app.png',
  });
});

This is the result of the example above:

Usage Result

Contributing

Contributions are welcome! Please open an issue or pull request if you find a bug or have a feature request.