@code-editor/preview-pip
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

PIP - Picture in picture

Picture in picture mode of preview inside the viewport for viewing UI Previews in more ux friendly way.

Resizable-PIP

A resizable picture-in-picture component for React.

<ResizablePIP>
  <div>I can be resized and moved around!</div>
</ResizablePIP>

Installing

$ yarn add @code-editor/preview-pip

Usage

This package has two major exports:

  • <ResizablePIP>: A simple PIP component that can be resized and moved around.
  • <PIP>: A simple PIP component that does not receive props and cannot be resized. Used as a base for the ResizablePIP component.

<ResizablePIP>

A <ResizablePIP> element wraps an existing element and extends it with the ability to be resized and moved around, above all content in the app.

ResizablePIP Usage

View the source for more.

import { ResizablePIP } from "@code-editor/preview-pip";

function App() {
  return (
    <div>
      <ResizablePIP
        width={500}
        heigt={500}
        minConstraints={[300, 300]}
        maxConstraints={[800, 800]}
      >
        <p>
          Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
          eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
          minim veniam, quis nostrud exercitation ullamco laboris nisi ut
          aliquip ex ea commodo consequat. Duis aute irure dolor in
          reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
          pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
          culpa qui officia deserunt mollit anim id est laborum.
        </p>
      </ResizablePIP>
    </div>
  );
}

export default App;

<ResizablePIP> Props:

//
// Props:
//
{
// Specifies initial PIP window width.
// Example: 600
// Default value: 500
width: number,

// Specifies initial PIP window height.
// Example: 600
// Default value: 500
height: number,

// Specifies the minimum size possible for the PIP window (width, height).
// Example: [100, 100]
// Default value: [300, 300]
minConstraints: [number, number]

// Specifies the maximum size possible for the PIP window (width, height).
// Example: [900, 900]
// Default value: [800, 800]
maxConstraints: [number, number]
}

References

https://www.w3.org/TR/picture-in-picture/

Disclaimer

The origin source was forked from - https://github.com/itielMaimon/resizable-pip under MIT License

License

MIT

Package Sidebar

Install

npm i @code-editor/preview-pip

Weekly Downloads

1

Version

0.0.2

License

MIT

Unpacked Size

11.5 kB

Total Files

11

Last publish

Collaborators

  • softmarshmallow