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

use-open-window

v1.5.0

Published

Fancy React hook for open links in windows

Downloads

5,049

Readme

use-open-window

react hook fully typed npm npm Coverage Status Build Status License Netlify Status

Useful & super tiny (less than 1KB ✔️) (❤️obvious dep on React only) hook to open links in new window.

Note: Version ^1.4.0 of this hook has dependency on React 18, if you wish to use it with React 17 then please use version ^1.3.0.

Installation

npm i use-open-window --save

Alternatively you may use yarn:

yarn add use-open-window

Link to npm: https://www.npmjs.com/package/use-open-window

Click here to see DEMO

Demo

Demo GIF

Usage

  • With URL and options passed to hook
    import { useOpenInWindow }  from 'use-open-window';
    
    const url = 'https://www.google.com/';
    const options = {
      centered: true, /* default */
      specs: {
          width: 800, /* window width */
          height: 600, /* window height */
      }
    };
    const App = () => {
      const [handleWindowOpen, newWindowHandle] = useOpenInWindow(url, options);
        
      return (
        <div className="App">
          <div onClick={handleWindowOpen}>Click me</div>
        </div>
      );
    }
    
    export default App;
  • With URL and options passed inside callback
    import { useOpenInWindow }  from 'use-open-window';
    
    const options = {
      url: 'https://www.google.com/' /* url to page to open */
      centered: true, /* default */
      specs: {
          width: 800, /* window width */
          height: 600, /* window height */
      }
    };
    const App = () => {
      const [handleWindowOpen, newWindowHandle] = useOpenInWindow();
        
      return (
        <div className="App">
          <div onClick={(ev) => handleWindowOpen(ev, options)}>Click me</div>
        </div>
      );
    }
    
    export default App;

Hook params

| Parameter | Type | Description | Required | |-----------|------------------------|---------------------------------------------------------|----------| | url | string | Url to load inside new window | Y | | options | UseOpenInWindowOptions | Set of hook options (centered, focus, window size etc.) | N |

Options

| Option | Description | Default | |--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| | name | Specifies the target attribute or the name of the window. The following values are supported: _blank - URL is loaded into a new window, or tab. _parent - URL is loaded into the parent frame _self - URL replaces the current page _top - URL replaces any framesets that may be loaded name - The name of the window (Note: the name does not specify the title of the new window) | _blank | | centered | Specifies if window should be centered | true | | focus | Puts new window in focus | true | | specs.width | The height of the window. Min. value is 100 (browser restriction). | 800 | | specs.height | The width of the window. Min. value is 100 (browser restriction). | 800 | | left | The left position of the window. Negative values not allowed. | undefined | | top | The top position of the window. Negative values not allowed. | undefined | | channelmode | Whether or not to display the window in theater mode. IE only | 'no' | | fullscreen | Whether or not to display the browser in full-screen mode. A window in full-screen mode must also be in theater mode. IE only. | 'no' | | location | Whether or not to display the address field. Opera only. | null | | menubar | Whether or not to display the menu bar. | null | | resizable | Whether or not the window is resizable. IE only. | null | | scrollbars | Whether or not to display scroll bars. IE, Firefox & Opera only. | null | | status | Whether or not to add a status bar | null | | titlebar | Whether or not to display the title bar. Ignored unless the calling application is an HTML Application or a trusted dialog box. | null | | toolbar | Whether or not to display the browser toolbar. IE and Firefox only. | null |

Dependencies Deps

None. Self source code only. (❤️obvious peer dep on React only)

Reliability

This package is fully tested with total coverage set to Coverage Status. If you found any issue please report it here.

License

Made with :sparkling_heart: by Bartlomiej Zuber ([email protected]) while traveling around the world, and licensed under the MIT License