npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sk-sketch-webview

v0.0.4

Published

A sketch module for creating an complex UI with a webview(configurable titlebar)

Downloads

5

Readme

sketch-module-web-view

A Sketch module for creating a complex UI with a webview.

Installation

To use this module in your Sketch plugin you need a bundler utility like skpm and add it as a dependency:

npm i -S sketch-module-web-view

Usage

import WebUI from 'sketch-module-web-view'

const options = {
  identifier: 'unique.id', // to reuse the UI
  x: 0,
  y: 0,
  width: 240,
  height: 180,
  background: NSColor.whiteColor(),
  blurredBackground: false,
  onlyShowCloseButton: false,
  title: 'My ui',
  hideTitleBar: false,
  shouldKeepAround: true,
  resizable: false,
  frameLoadDelegate: { // https://developer.apple.com/reference/webkit/webframeloaddelegate?language=objc
    'webView:didFinishLoadForFrame:': function (webView, webFrame) {
      context.document.showMessage('UI loaded!')
      WebUI.clean()
    }
  },
  uiDelegate: {}, // https://developer.apple.com/reference/webkit/webuidelegate?language=objc
  onPanelClose: function () {
    // Stuff
    // return `false` to prevent closing the panel
  }
}

const webUI = new WebUI(context, require('./my-screen.html'), options)

Communicating with the webview

Executing JS on the webview from the plugin

const res = webUI.eval('someJSFunction()')

Executing JS on the webview from the another plugin or command

import { isWebviewPresent, sendToWebview } from 'sketch-module-web-view/remote'

if (isWebviewPresent('unique.id')) {
  sendToWebview('unique.id', 'someJSFunction()')
}

Executing JS in the plugin from the webview

On the plugin:

options.handlers = {
  nativeLog: function (s) {
    context.document.showMessage(s)
  }
}

On the webview:

import pluginCall from 'sketch-module-web-view/client'

pluginCall('nativeLog', 'Called from the webview')

⚠️ When using options.handlers, the webView:didChangeLocationWithinPageForFrame: method of the frameLoadDelegate will be overwritten.

⚠️ When calling pluginCall, the window.location.hash will be modified.

Inspecting the WebView

If your plugin is using a webview, chances are that you will need to inspect it at some point.

To do so, you need to add the preference:

defaults write com.bohemiancoding.sketch3 WebKitDeveloperExtras -bool true

Then you can simply right-click on your webview and click on Inspect. The inspector should show up.