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

solid-new-window

v0.0.5

Published

SolidJS component for rendering a piece of content in a new window.

Downloads

480

Readme

New Window for SolidJS

SolidJS component for rendering a piece of content in a new window using the window.open API.

Inspired by react-new-window, (APIs do not match 100%).

Installation

npm install solid-new-window

Usage

import { render } from "solid-js/web";
import { NewWindow } from "solid-new-window";

const Demo = () => (
  <NewWindow>
    <h1>Hello from SolidJS 👋</h1>
  </NewWindow>
);

const cleanup = render(() => <Demo />, ...);

/* IMPORTANT */
window.addEventListener("pagehide", cleanup);

When <NewWindow /> is mounted, a new window will be opened. When unmounted, the new window will be closed. The IMPORTANT cleanup part ensures that when the parent window is closed, <NewWindow /> also closes. It wouldn't make sense to keep it open, because the content is powered by SolidJS running in the parent window.

API Documentation

NewWindow props

| Property | Type | Default | Description | | -------- | ---- | ------- | ----------- | | title | string | "Untitled" | Title of the new window's document. (Shown in the browser tab) | | center | boolean \| "parent" \| "screen" | false | If true or parent, the new window will be centered according to its parent window, screen will center the new window according to the screen. In order for window centering to work, width and height must be provided in features. | | features | WindowFeatures | | See window features for more details. | | fallback | (reopen) => JSX.Element | | User can close the window at any point. What should be rendered when they do? Perhaps a re-open button? | | inline | (focus) => JSX.Element | | What should be rendered while the window is opened? Perhaps a re-focus button? | | openOnMount | boolean | true | Set to false if you would like to opt out of automatically opening the window on mount. Instead, fallback will be shown. | | copyStyles | boolean | true | Copy styles from parent window's document. Only works in secure contexts! | | ref | (newWindow) => void | | Allows you to get the new window reference for manual manipulation. | | containerRef | (element) => void | | Because a <Portal> is used, the content will be mounted inside a <div>. This prop gives you access to this div. E.g. for additional styling. |

Context hooks

  • useWindow(): Window | undefined - returns the new Window object if called inside the new window content.
  • useFocusParent(): VoidFunction | undefined - returns a function to focus the parent window if called inside the new window content.

Fully Featured Example

function App() {
  const [showWindow, setShowWindow] = createSignal(false)
  const [count, setCount] = createSignal(0)
  const increment = () => setCount((p) => p + 1)
  const toggle = () => setShowWindow((p) => !p)

  return (
    <>
      <button onClick={increment}>+</button>
      <button onClick={toggle}>{showWindow() ? "Close" : "Open"}</button>
      <Show when={showWindow()}>
        <NewWindow
          title={`Title ${count()}`}
          center="parent"
          features={{
            popup: true,
            width: 400,
            height: 300,
          }}
          inline={(focus) => <button onClick={focus}>Focus</button>}
          fallback={(reopen) => <button onClick={reopen}>Reopen</button>}
        >
          <Content count={count()} />
        </NewWindow>
      </Show>
    </>
  )
}

function Content(props) {
  const focusParent = useFocusParent()

  return (
    <>
      Counter: {props.count}
      <button onClick={focusParent}>Focus Parent</button>
    </>
  )
}

Live demo @ playground.solidjs.com (copyStyles does not work in playground, I don't understand exactly why)