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

@marsio/vue-split-pane

v1.0.0

Published

A Vue 3 component for creating resizable split panes. This component allows you to easily create layouts with resizable panels, either horizontally or vertically. It supports various features such as initial size, minimum and maximum size constraints, and

Downloads

7

Readme

Vue Split Pane

A Vue 3 component for creating resizable split panes. This component allows you to easily create layouts with resizable panels, either horizontally or vertically. It supports various features such as initial size, minimum and maximum size constraints, and nested panes.

See the example and associated code in ExampleLayout

[Demo | Changelog | View Example]

Quick Start

This package has two major exports:

  • <SplitPane>: is used to create resizable panels within a layout. It supports both vertical and horizontal splits, allowing users to adjust the size of different sections of a page.
  • <Pane>: is a part of the SplitPane layout system, representing an individual resizable panel. It supports both vertical and horizontal splits and allows for flexible sizing and styling.

To quickly start using @marsio/vue-split-pane, follow the steps below:

Step 1: Installation

First, you need to install the package. Run the following command in your project directory:

npm install @marsio/vue-split-pane

or if you prefer using Yarn:

yarn add @marsio/vue-split-pane

or if you prefer using Pnpm:

pnpm add @marsio/vue-split-pane

Step 2: Importing

In your Vue component, import @marsio/vue-split-pane:

import SplitPane, { Pane } from '@marsio/vue-split-pane';

Step 3: Using @marsio/vue-split-pane

Now, you can use the SplitPane component in your Vue application

<template>
  <SplitPane>
    <Pane>This is a Pane</Pane>
    <Pane>This is a Pane</Pane>
  </SplitPane>     
</template>

<script>
import SplitPane, { Pane } from '@marsio/vue-split-pane';

export default {
  components: {
    SplitPane,
    Pane
  }
}
</script>

Or Hybrid

<template>
  <SplitPane split="vertical">
    <Pane initialSize="200px">You can use a Pane component</Pane>
    <div>or you can use a plain old div</div>
    <Pane initialSize="25%" minSize="10%" maxSize="500px">Using a Pane allows you to specify any constraints directly</Pane>
  </SplitPane>    
</template>

<script>
import SplitPane, { Pane } from '@marsio/vue-split-pane';

export default {
  components: {
    SplitPane,
    Pane
  }
}
</script>

Or Nested

<template>
   <SplitPane split="vertical">
    <Pane/>
    <Pane/>
    <SplitPane split="horizontal">
      <Pane/>
      <Pane/>
      <Pane/>
    </SplitPane>
    <Pane/>
  </SplitPane>  
</template>

<script>
import SplitPane, { Pane } from '@marsio/vue-split-pane';

export default {
  components: {
    SplitPane,
    Pane
  }
}
</script>

Step 4: Enjoy!

That's it! You've successfully integrated split pane functionality into your Vue application. Customize it further according to your needs.

<SplitPane> Props:

// Determines if the pane is resizable. Default is true.
allowResize: { type: Boolean, default: true },

// Size of the resizer in pixels. Default is 1.
resizerSize: {
  type: Number,
  default: 1
},

// Direction of the split. Can be either 'vertical' or 'horizontal'. Default is 'vertical'.
split: {
  type: String as PropType<"vertical" | "horizontal">,
  default: 'vertical'
},

// Step size for resizing in pixels. Default is 1.
step: { type: Number, default: 1 }

<Pane> Props:

// The index of the pane. Typically used to identify the pane in a list.
index: {
  type: Number as PropType<number>
},

// Custom CSS class for the pane.
class: {
  type: String as PropType<string>
},

// Direction of the split. Can be either 'vertical' or 'horizontal'.
split: {
  type: String as PropType<'vertical' | 'horizontal'>
},

// Initial size of the pane. Can be a string (e.g., '50%') or a number (e.g., 200).
initialSize: {
  type: [String, Number] as PropType<string | number>,
  default: '1'
},

// Minimum size of the pane. Can be a string (e.g., '10%') or a number (e.g., 100px).
minSize: {
  type: String as PropType<string>,
  default: '0'
},

// Maximum size of the pane. Can be a string (e.g., '90%') or a number (e.g., 500px).
maxSize: {
  type: String as PropType<string>,
  default: '100%'
},

// Current size of the pane. Can be a string (e.g., '50%') or a number (e.g., 200).
size: {
  type: String as PropType<string>
},

// Reference to the inner element of the pane. Typically used for DOM manipulation.
innerRef: {
  type: Function,
  default: () => () => {}
},

// Size of the resizers in pixels. Default is 1.
resizersSize: {
  type: Number,
  default: 1
}

Modern browsers.

| Edge | Firefox | Chrome | Safari | Opera | | --- | --- | --- | --- | --- | | Edge | last 2 versions | last 2 versions | last 2 versions | last 2 versions |

Changelog.

Detailed changes for each release are documented in the release notes.

Release checklist

  • Update CHANGELOG
  • pnpm release
  • pnpm publish

License

MIT