Skip to content

Commit 36fb485

Browse files
committed
Add NPM module support
1 parent 3c6bcdd commit 36fb485

File tree

3 files changed

+76
-0
lines changed

3 files changed

+76
-0
lines changed

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# ActiveAdmin Searchable Select
22

33
[![Gem Version](https://badge.fury.io/rb/activeadmin-searchable_select.svg)](http://badge.fury.io/rb/activeadmin-searchable_select)
4+
[![NPM Version](https://badge.fury.io/js/@codevise%2Factiveadmin-searchable_select.svg)](https://badge.fury.io/js/@codevise%2Factiveadmin-searchable_select)
5+
![npm](https://img.shields.io/npm/dm/@codevise/activeadmin-searchable_select)
46
[![Build Status](https://github.com/codevise/activeadmin-searchable_select.svg?branch=master)](https://github.com/codevise/activeadmin-searchable_select/actions)
57

68
Searchable select boxes (via [Select2](https://select2.org/)) for
@@ -15,6 +17,7 @@ Add `activeadmin-searchable_select` to your Gemfile:
1517
gem 'activeadmin-searchable_select'
1618
```
1719

20+
##### Using assets via Sprockets
1821
Import stylesheets and require javascripts:
1922

2023
```scss
@@ -27,6 +30,39 @@ Import stylesheets and require javascripts:
2730
//= require active_admin/searchable_select
2831
```
2932

33+
##### Using assets via Webpacker (or any other assets bundler) as a NPM module (Yarn package)
34+
35+
Execute:
36+
37+
$ npm i @codevise/activeadmin-searchable_select
38+
39+
Or
40+
41+
$ yarn add @codevise/activeadmin-searchable_select
42+
43+
Or add manually to `package.json`:
44+
45+
```json
46+
"dependencies": {
47+
"@codevise/activeadmin-searchable_select": "1.6.0"
48+
}
49+
```
50+
and execute:
51+
52+
$ yarn
53+
54+
Add the following line into `app/assets/javascripts/active_admin.js`:
55+
56+
```javascript
57+
import '@codevise/activeadmin-searchable_select';
58+
```
59+
60+
Add the following line into `app/assets/stylesheets/active_admin.scss`:
61+
62+
```css
63+
@import '@codevise/activeadmin-searchable_select';
64+
```
65+
3066
## Usage
3167

3268
### Making Select Boxes Searchable
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
import 'select2';
2+
import './searchable_select/init';

package.json

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"name": "@codevise/activeadmin-searchable_select",
3+
"version": "1.6.0",
4+
"description": "Use searchable selects based on Select2 in Active Admin forms and filters.",
5+
"main": "src/searchable_select.js",
6+
"style": "src/searchable_select.scss",
7+
"repository": "[email protected]:codevise/activeadmin-searchable_select.git",
8+
"author": "Codevise Solutions Ltd <[email protected]>",
9+
"license": "MIT",
10+
"private": false,
11+
"repository": {
12+
"type": "git",
13+
"url": "git+https://github.com/codevise/activeadmin-searchable_select.git"
14+
},
15+
"bugs": {
16+
"url": "https://github.com/codevise/activeadmin-searchable_select/issues"
17+
},
18+
"homepage": "https://github.com/codevise/activeadmin-searchable_select#readme",
19+
"keywords": [
20+
"select2",
21+
"active",
22+
"admin",
23+
"searchable",
24+
"select"
25+
],
26+
"dependencies": {
27+
"jquery": ">= 3.0, < 5",
28+
"select2": "~> 4.0"
29+
},
30+
"files": [
31+
"src/**/*"
32+
],
33+
"scripts": {
34+
"prepare_javascripts_src": "rm -rf src && cp -R app/assets/javascripts/active_admin/ src && mv src/searchable_select_pack.js src/searchable_select.js",
35+
"prepare_stylesheets_src": "cp -R app/assets/stylesheets/active_admin/ src",
36+
"prepublishOnly": "npm run prepare_javascripts_src && npm run prepare_stylesheets_src"
37+
}
38+
}

0 commit comments

Comments
 (0)