Skip to content

Commit 095d833

Browse files
Merge pull request #11 from williamtroup/1.0.0
1.0.0
2 parents 0e7a8f8 + 0f1f865 commit 095d833

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+4710
-586
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
/.vs
22
/.vscode
3-
*.DS_Store
3+
.DS_Store
44
*.nupkg
5+
/build
6+
/node_modules

.npmignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/.github
2+
/.vscode
3+
/test
4+
/build
5+
CODE_OF_CONDUCT.md
6+
CONTRIBUTING.md
7+
select.js.nuspec
8+
PACK.sh
9+
PUBLISH.sh
10+
README_NUGET.md
11+
SECURITY.md
12+
SERVE.sh
13+
package-lock.json
14+
tsconfig.json
15+
tsup.build.config.ts
16+
tsup.build.esm.config.ts
17+
tsup.build.min.config.ts
18+
BUILD_INSTRUCTIONS.md
19+
*.nupkg

BUILD_INSTRUCTIONS.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Building Select.js
2+
3+
Before getting started with Select.js, please read through the following instructions:
4+
5+
6+
## Step 1: Install Packages:
7+
8+
Install the packages using the following NPM commands:
9+
10+
### 1. Install TypeScript:
11+
12+
```markdown
13+
npm install -g typescript
14+
```
15+
16+
### 2. Install tsup:
17+
18+
```markdown
19+
npm i tsup -D
20+
```
21+
22+
### 3. Install terser:
23+
24+
```markdown
25+
npm install terser -D
26+
```
27+
28+
### 4. Install swc/core (if ES5 is required):
29+
30+
```markdown
31+
npm install @swc/core -D
32+
```
33+
34+
35+
## Step 2: Build Project:
36+
37+
### 1. Full Build:
38+
39+
To build the TypeScript, run the following command:
40+
41+
```markdown
42+
npm run build-typescript
43+
```
44+
45+
To build the SASS, run the following command:
46+
47+
```markdown
48+
npm run build-sass
49+
```
50+
51+
To build the everything, run the following command:
52+
53+
```markdown
54+
npm run build
55+
```
56+
57+
### 2. Minimized Build:
58+
59+
To build the TypeScript, run the following command:
60+
61+
```markdown
62+
npm run build-minimized-typescript
63+
```
64+
65+
To build the SASS, run the following command:
66+
67+
```markdown
68+
npm run build-minimized-sass
69+
```
70+
71+
To build the everything, run the following command:
72+
73+
```markdown
74+
npm run build-minimized
75+
```
76+
77+
### 3. ESM Build:
78+
79+
To build the TypeScript, run the following command:
80+
81+
```markdown
82+
npm run build-typescript-esm
83+
```

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
Select.js
33

44
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Select.js%2C%20a%20free%20JavaScript%select%builder&url=https://github.com/williamtroup/Select.js&hashtags=javascript,html,select)
5-
[![npm](https://img.shields.io/badge/npmjs-v0.5.0-blue)](https://www.npmjs.com/package/jselect.js)
6-
[![nuget](https://img.shields.io/badge/nuget-v0.5.0-purple)](https://www.nuget.org/packages/jSelect.js/)
5+
[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jselect.js)
6+
[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jSelect.js/)
77
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Select.js/blob/main/LICENSE.txt)
88
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Select.js/discussions)
99
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://github.com/williamtroup)
1010
</h1>
1111

1212
> <p align="center">A lightweight, and easy-to-use, JavaScript library for creating multi-select drop-down lists!</p>
13-
> <p align="center">v0.5.0</p>
13+
> <p align="center">v1.0.0</p>
1414
<br />
1515
1616
![Select.js](docs/images/main.png)
@@ -21,7 +21,9 @@ Select.js
2121
<h1>What features does Select.js have?</h1>
2222

2323
- Zero-dependencies and extremely lightweight!
24+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
2425
- Maintains existing SELECT DOM element for FORM compatibility.
26+
- Easily select and de-select your list items, which are shown as tags!
2527
- Full API available via public functions.
2628
- Fully styled in CSS/SASS (including the buttons) and compatible with the Bootstrap library.
2729
- Full CSS theme support (using :root variables, with a default dark-mode theme).
@@ -85,22 +87,22 @@ Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows
8587
### 3. DOM Element Binding:
8688

8789
```markdown
88-
<select multiple="multiple" data-select-options="{ 'render': true }">
90+
<select multiple="multiple" data-select-js="{ 'render': true }">
8991
<option value="1" selected="selected">Value 1</option>
9092
<option value="2">Value 2</option>
9193
<option value="2">Value 3</option>
9294
</select>
9395

94-
<select data-select-options="{ 'render': true }">
96+
<select data-select-js="{ 'render': true }">
9597
<option value="1">Value 1</option>
9698
<option value="2">Value 2</option>
9799
<option value="2">Value 3</option>
98100
</select>
99101
```
100102

101-
To see a list of all the available binding options you can use for "data-select-options", click [here](docs/binding/OPTIONS.md).
103+
To see a list of all the available binding options you can use for "data-select-js", click [here](docs/binding/OPTIONS.md).
102104

103-
To see a list of all the available custom triggers you can use for "data-select-options", click [here](docs/binding/CUSTOM_TRIGGERS.md).
105+
To see a list of all the available custom triggers you can use for "data-select-js", click [here](docs/binding/CUSTOM_TRIGGERS.md).
104106

105107
<br>
106108

README_NUGET.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Select.js v0.5.0
1+
# Select.js v1.0.0
22

33
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Select.js%2C%20a%20free%20JavaScript%select%builder&url=https://github.com/williamtroup/Select.js&hashtags=javascript,html,select)
4-
[![npm](https://img.shields.io/badge/npmjs-v0.5.0-blue)](https://www.npmjs.com/package/jselect.js)
5-
[![nuget](https://img.shields.io/badge/nuget-v0.5.0-purple)](https://www.nuget.org/packages/jSelect.js/)
4+
[![npm](https://img.shields.io/badge/npmjs-v1.0.0-blue)](https://www.npmjs.com/package/jselect.js)
5+
[![nuget](https://img.shields.io/badge/nuget-v1.0.0-purple)](https://www.nuget.org/packages/jSelect.js/)
66
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Select.js/blob/main/LICENSE.txt)
77
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Select.js/discussions)
88
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://github.com/williamtroup)
@@ -13,7 +13,9 @@
1313
## What features does Select.js have?
1414

1515
- Zero-dependencies and extremely lightweight!
16+
- Written in TypeScript, allowing greater support for React, Angular, and other libraries!
1617
- Maintains existing SELECT DOM element for FORM compatibility.
18+
- Easily select and de-select your list items, which are shown as tags!
1719
- Full API available via public functions.
1820
- Fully styled in CSS/SASS (including the buttons) and compatible with the Bootstrap library.
1921
- Full CSS theme support (using :root variables, with a default dark-mode theme).
@@ -62,22 +64,22 @@ Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows
6264
### 3. DOM Element Binding:
6365

6466
```markdown
65-
<select multiple="multiple" data-select-options="{ 'render': true }">
67+
<select multiple="multiple" data-select-js="{ 'render': true }">
6668
<option value="1" selected="selected">Value 1</option>
6769
<option value="2">Value 2</option>
6870
<option value="2">Value 3</option>
6971
</select>
7072

71-
<select data-select-options="{ 'render': true }">
73+
<select data-select-js="{ 'render': true }">
7274
<option value="1">Value 1</option>
7375
<option value="2">Value 2</option>
7476
<option value="2">Value 3</option>
7577
</select>
7678
```
7779

78-
To see a list of all the available binding options you can use for "data-select-options", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/binding/OPTIONS.md).
80+
To see a list of all the available binding options you can use for "data-select-js", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/binding/OPTIONS.md).
7981

80-
To see a list of all the available custom triggers you can use for "data-select-options", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/binding/CUSTOM_TRIGGERS.md).
82+
To see a list of all the available custom triggers you can use for "data-select-js", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/binding/CUSTOM_TRIGGERS.md).
8183

8284

8385
### 4. Finishing Up:

dist/select.d.mts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

dist/select.d.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
export { }

0 commit comments

Comments
 (0)