Skip to content

Commit

Permalink
changes to publish in npm
Browse files Browse the repository at this point in the history
  • Loading branch information
sa-si-dev committed Jul 28, 2021
1 parent c6febec commit 5a77e36
Show file tree
Hide file tree
Showing 10 changed files with 120 additions and 20 deletions.
20 changes: 20 additions & 0 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Virtual Select <small>1.0</small>

> A javascript plugin for dropdown with virtual scroll
- Simple and lightweight
- Support more than 100000 dropdown options
- Support multi-select
- Support search feature

[Documentation](https://sa-si-dev.github.io/virtual-select)

[Changelog](https://github.com/sa-si-dev/virtual-select/releases)

## Commands

| Command | Description |
|---------|-------------|
| npm run start | Builds dist versions of the plugin on file change |
| npm run build | Builds dist versions of the plugin |
| npm run docs | Starts a local documentation server |
22 changes: 22 additions & 0 deletions .github/workflows/npm-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages

name: Node.js Package

on:
release:
types: [created]

jobs:
publish-npm:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14
registry-url: https://registry.npmjs.org/
- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
.vscode
.DS_Store
node_modules
node_modules
6 changes: 6 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.vscode
.DS_Store
node_modules

.github
docs
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Virtual Select <small>1.0</small>
# Virtual Select Plugin

> A javascript plugin for dropdown with virtual scroll
Expand All @@ -11,10 +11,19 @@

[Changelog](https://github.com/sa-si-dev/virtual-select/releases)

## Commands
## Install

| Command | Description |
|---------|-------------|
| npm run start | Builds dist versions of the plugin on file change |
| npm run build | Builds dist versions of the plugin |
| npm run docs | Starts a local documentation server |
```shell
npm install --save virtual-select-plugin
```

## Import files

```html
<link rel="stylesheet" href="node_modules/virtual-select-plugin/dist/virtual-select.min.css">
<script src="node_modules/virtual-select-plugin/dist/virtual-select.min.js"></script>

<!-- optional -->
<link rel="stylesheet" href="node_modules/tooltip-plugin/dist/tooltip.min.css">
<script src="node_modules/tooltip-plugin/dist/tooltip.min.js"></script>
```
23 changes: 21 additions & 2 deletions docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ OR from below direct links

[virtual-select.min.js](https://raw.githubusercontent.com/{{repo}}/master/dist/virtual-select.min.js)

[tooltip.min.css](https://raw.githubusercontent.com/{{repo}}/master/dist/tooltip.min.css)
[tooltip.min.css](https://raw.githubusercontent.com/sa-si-dev/tooltip/master/dist/tooltip.min.css)

[tooltip.min.js](https://raw.githubusercontent.com/{{repo}}/master/dist/tooltip.min.js)
[tooltip.min.js](https://raw.githubusercontent.com/sa-si-dev/tooltip/master/dist/tooltip.min.js)


## Import files
Expand All @@ -45,6 +45,25 @@ Tooltip would be used to show selected values and options text, if text is long
If you want to use tooltip plug-in in your project, refer [Tooltip Documentation](https://sa-si-dev.github.io/tooltip)
## Install from NPM
We could install this plugin from NPM and use it
```shell
npm install --save virtual-select-plugin
```
## Import files from node_modules
```html
<link rel="stylesheet" href="node_modules/virtual-select-plugin/dist/virtual-select.min.css">
<script src="node_modules/virtual-select-plugin/dist/virtual-select.min.js"></script>

<!-- optional -->
<link rel="stylesheet" href="node_modules/tooltip-plugin/dist/tooltip.min.css">
<script src="node_modules/tooltip-plugin/dist/tooltip.min.js"></script>
```

## Initiatize plugin

```html
Expand Down
20 changes: 17 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 14 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
{
"name": "virtual-select",
"version": "1.0.0",
"name": "virtual-select-plugin",
"version": "1.0.13",
"description": "A javascript plugin for dropdown with virtual scroll",
"scripts": {
"start": "webpack --mode development --watch",
"build": "webpack --mode production",
"docs": "docsify serve docs"
},
"author": "",
"author": "Sa Si Dev",
"keywords": [
"javascript",
"plugin",
"select",
"dropdown",
"virtual select",
"virtual scroll"
],
"license": "ISC",
"dependencies": {
"tooltip-plugin": "^1.0.14"
},
"devDependencies": {
"@babel/core": "^7.14.0",
"@babel/preset-env": "^7.14.0",
Expand Down
2 changes: 1 addition & 1 deletion src/virtual-select.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Utils, DomUtils } from './utils';

const virtualSelectVersion = 'v1.0.12';
const virtualSelectVersion = 'v1.0.13';
const dropboxCloseButtonFullHeight = 48;
const searchHeight = 40;

Expand Down
5 changes: 2 additions & 3 deletions webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const MiniCssExtractPlugin = require('mini-css-extract-plugin');
const TerserPlugin = require('terser-webpack-plugin');
const FileManagerPlugin = require('filemanager-webpack-plugin');

const banner = `Virtual Select v1.0.12
const banner = `Virtual Select v1.0.13
https://sa-si-dev.github.io/virtual-select
Licensed under MIT (https://github.com/sa-si-dev/virtual-select/blob/master/LICENSE)`;

Expand Down Expand Up @@ -37,8 +37,7 @@ module.exports = (env, options) => {
onEnd: {
delete: ['dist/styles.min.js'],
copy: [
{ source: 'static', destination: 'dist' },
{ source: 'static', destination: 'docs/assets' },
{ source: 'node_modules/tooltip-plugin/dist', destination: 'docs/assets' },
{ source: 'dist', destination: 'docs/assets' },
],
},
Expand Down

0 comments on commit 5a77e36

Please sign in to comment.