https://github.com/egoist/vue-windows

Vue components for creating neat windows.
https://github.com/egoist/vue-windows

Last synced: 3 days ago
JSON representation

Vue components for creating neat windows.

• Host: GitHub
• URL: https://github.com/egoist/vue-windows
• Owner: egoist
• License: mit
• Created: 2016-10-05T06:52:29.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T01:31:18.000Z (about 2 years ago)
• Last Synced: 2024-11-23T12:49:49.507Z (20 days ago)
• Language: Vue
• Homepage: https://vue-windows.egoist.moe
• Size: 3.04 MB
• Stars: 122
• Watchers: 5
• Forks: 11
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - vue-windows

README

        
# vue-windows [![NPM version](https://img.shields.io/npm/v/vue-windows.svg?style=flat-square)](https://npmjs.com/package/vue-windows) [![NPM downloads](https://img.shields.io/npm/dm/vue-windows.svg?style=flat-square)](https://npmjs.com/package/vue-windows) [![Build Status](https://img.shields.io/circleci/project/egoist/vue-windows/master.svg?style=flat-square)](https://circleci.com/gh/egoist/vue-windows)

It's inspired by the [socket.io](http://socket.io/) homepage, only 1kb.

## Install

```bash

$ npm install --save vue-windows

```

## Usage

```vue

  


    

      editor window body

    

    

      browser window body

    

  


import {EditorWindow, BrowserWindow} from 'vue-windows'

export default {

  components: {

    EditorWindow,

    BrowserWindow

  }

}

```

## API

### Props

#### title

- Type: `string`

- Required: `true`

#### shadow

- Type: `boolean`

- Default: `false`

Whether to show window shadow.

#### theme

- Type: `string`

- Default: `default`

- Available: `default`, `dark`

#### width

- Type: `number`, `string`

- Default: `100%`

Number values are resolved into lengths in `px` while string values are used directly.

#### height

- Type: `number`, `string`

- Default: `340`

Number values are resolved into lengths in `px` while string values are used directly.

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Development

```bash

yarn

yarn example

```

## License

[MIT](https://egoist.mit-license.org/) © [EGOIST](https://github.com/egoist)