Pop launcher toolkit

A toolkit for creating plugins for the Pop!_OS launcher using Typescript.

Install

npm install pop-launcher-toolkit

Usage

See Pop launcher README.md for more information on how to create these plugins. They can be written in any language, this toolkit helps with the boilerplate of creating one in Typescript.

Here's a few plugins that I've personnaly created : Jeusto/pop-launcher-plugins. You can check the awesome-pop-launcher repo for even more examples.

All you have to do is extend the PopPlugin class and implement the functions that you need. In the main function you can the simply initialize the plugin and call the run() and it will take care of the rest.

import { PopPlugin } from 'pop-launcher-toolkit';

async function main() {
  const plugin = await HelloWorldPlugin.init();
  plugin.run();
}

class HelloWorldPlugin extends PopPlugin {
  private constructor() {
    super();
  }

  static async init(): Promise<HelloWorldPlugin> {
    return new HelloWorldPlugin();
  }

  search(query: string) {}
  activate(index: number) {}
}

main();

API

[ ] Todo