@pulsar-edit/types 1.128.1

package/tool-bar/index.d.ts

@@ -0,0 +1,235 @@
+// tool-bar 1.2.x
+// https://web.pulsar-edit.dev/packages/tool-bar
+// Definitions by: aminya <https://github.com/aminya>
+
+/// <reference path="./config.d.ts" />
+
+import { Disposable, TooltipPlacement } from "../index";
+
+export declare interface ButtonOptions {
+  /**
+   *  Icon name.
+   *
+   * ## Example:
+   * ```js
+   * icon: 'octoface',
+   * ```
+   */
+  icon?: string;
+
+  /**
+   * Icon set name.
+   *
+   * It can be chosen among these:
+   *
+   * - Not given: if `iconset` is not given Octicons (default Pulsar's flavor)
+   *   is chosen
+   * - `ion` with `ios-` and `md- `prefixes for the icon names (Ionicons)
+   * - `fa` and fab for brands (FontAwesome)
+   * - `fi` (Foundation)
+   * - `icomoon` (IcoMoon)
+   * - `devicon` (Devicon)
+   * - `mdi` (MaterialDesignIcons)
+   *
+   * ```ts
+   *   {
+   *     icon: 'ios-gear-a',
+   *     iconset: 'ion'
+   *   }
+   * ```
+   */
+  iconset?: undefined | "ion" | "fa" | "fab" | "fi" | "icomoon" | "devicon" | "mdi";
+
+  /**
+   * You can use `text` to add text for a button or to use HTML for a button
+   * (if `html` is set to `true`).
+   *
+   *
+   * ```ts
+   * {
+   *   text: '<b>BIG</b> button',
+   *   html: true,
+   * }
+   * ```
+   */
+  text?: string;
+
+  /**
+   * If set to `true`, `text` will be rendered as HTML.
+   */
+  html?: boolean;
+
+  /**
+   * The callback must be either
+   *
+   * - Pulsar command: a string or array of strings,
+   * - a custom callback function, or
+   * - an object where the keys are key modifiers (`alt`, `ctrl` or `shift`)
+   *   and the values are commands or custom functions.
+   *
+   * ## Example:
+   * ```ts
+   * callback: 'application:about',
+   * ```
+   *
+   * ## Example - Callback with modifiers
+   * ```ts
+   * {
+   *    callback: {
+   *     '': 'application:cmd-1',      // Without modifiers is default action
+   *     'alt': 'application:cmd-2',
+   *     'ctrl': 'application:cmd-3',  // With function callback
+   *     'shift'(data) {
+   *       console.log(data);
+   *     },
+   *     'alt+shift': 'application:cmd-5',       // Multiple modifiers
+   *     'alt+ctrl+shift': 'application:cmd-6'   // All modifiers
+   *   },
+   *   data: 'foo'
+   * }
+   * ```
+   */
+  callback:
+  | string
+  | Array<string>
+  | ((data?: any) => void)
+  | { [modifier: string]: string }
+  | { [modifier: string]: (data?: any) => void };
+
+  /**
+   * `data` can be passed as the input argument of callback if callback is of
+   * type
+   * - `(data: any) => void)` or
+   * - `{ [modifier: string]: ((data: any) => void) }`,
+   */
+  data?: any;
+
+  /** (optional) defaults to `50` */
+  priority?: number;
+
+  /**
+   * The tooltip option may be a string or an object that is passed to Pulsar's
+   * TooltipManager.
+   */
+  tooltip?:
+  | string // minimally sets title
+  // similar to what TooltipManager.add options accepts:
+  | { item?: object }
+  | ({
+    title?: string | (() => string);
+    html?: boolean;
+    keyBindingCommand?: string;
+    keyBindingTarget?: HTMLElement;
+  } & {
+    class?: string;
+    placement?: TooltipPlacement | (() => TooltipPlacement);
+    trigger?: "click" | "hover" | "focus" | "manual";
+    delay?: { show: number; hide: number };
+  });
+
+  /** Color of the button. */
+  color?: string;
+
+  /** Color of the button's background. */
+  background?: string;
+
+  /**
+   * Buttons can be styled with arbitrary CSS through classes.
+  * An example of how the class can be used is show below.
+  *
+  * ## Example:
+  * ```ts
+  * class: 'my-awesome-class'
+  * ```
+  *
+  * ## Example:
+  * ```ts
+  * class: ['multiple', 'classes', 'also', 'works']
+  * ```
+  */
+  class?: string | Array<string>;
+}
+
+export declare interface SpacerOptions {
+  /** (optional) defaults to `50` */
+  priority?: number;
+}
+
+declare interface ToolBarButtonView {
+  element: HTMLButtonElement;
+  subscriptions: Disposable;
+  priority: number;
+  options: ButtonOptions;
+  group: string;
+  enabled: boolean;
+
+  setEnabled(enabled: boolean): void;
+
+  setSelected(selected: boolean): void;
+
+  getSelected(): boolean;
+
+  _onMouseDown(event: MouseEvent): void;
+
+  _onClick(event: MouseEvent): void;
+
+  executeCallback(event: MouseEvent): void;
+
+  destroy(): void;
+}
+
+declare interface ToolBarSpacerView {
+  element: HTMLHRElement;
+  priority: number;
+  group: string;
+
+  destroy(): void;
+}
+
+export declare interface ToolBarManager {
+  /** Adds a button. The input to this function is a `ButtonOptions` object */
+  addButton(options: ButtonOptions): ToolBarButtonView;
+
+  /** Adds a spacer. Optionally, you can pass a `SpacerOptions` object */
+  addSpacer(options?: SpacerOptions): ToolBarSpacerView;
+
+  /**
+   * Use the method removeItems to remove the buttons added by your package.
+   * This is particular useful in your package deactivate method, but can be
+   * used at any time.
+   */
+  removeItems(): void;
+
+  /**
+   * The onDidDestroy method takes a function that will be called when the
+   * tool-bar package is destroyed. This is useful if your package needs to do
+   * cleanup when the tool-bar is deactivated but your package continues
+   * running.
+   */
+  onDidDestroy(callback: () => void): void;
+}
+
+/**
+ *  Passed as an input to `consumeToolBar(getToolBar: getToolBarManager)`
+ *  function of your package.
+ *
+ *  In your main package file, add the following methods and replace
+ *  your-package-name with your package name.
+ *
+ * ```ts
+ *  let toolBar: ToolBarManager
+ *
+ *  export function consumeToolBar(getToolBar: getToolBarManager) {
+ *   toolBar = getToolBar("packageName");
+ *   // Add buttons and spacers here...
+ * }
+ *
+ *  export function deactivate() {
+ *   if (toolBar) {
+ *     toolBar.removeItems();
+ *     toolBar = null;
+ *   }
+ * }
+ * ```
+ */
+export type getToolBarManager = (packageName: string) => ToolBarManager;

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "noEmit": true,
+    "skipLibCheck": true
+  },
+  "include": ["**/*.d.ts"]
+}