@@ -11,9 +11,8 @@ with NHMMER and also adds text search functionality, backed by EBI
11
11
Lucene text search plugin.
12
12
13
13
This plugin is written in React/Redux and makes use of Zurb
14
- Foundation-based EBI theme. It is bundled with CSS modules and
15
- UMD wrapper and packaged with Webpack, so it should not clash with
16
- your website's javascript or CSS.
14
+ Foundation-based EBI theme. It is bundled as a Web Component, so it
15
+ should not clash with your website's javascript or CSS.
17
16
18
17
## Installation
19
18
26
25
` git clone https://github.com/RNAcentral/rnacentral-sequence-search-embed.git `
27
26
28
27
29
- Now you can add the javascript bundle and css bundle to your web page either directly or through
30
- an import with Webpack or native ECMAscript modules and CSS modules.
28
+ Now you can add the component's javascript bundle (it contains all the styles and fonts)
29
+ to your web page either directly or through an import with Webpack:
31
30
32
- For a minimal example, see [ index.html] ( ./index.html ) .
33
-
34
- Javascript bundle is wrapped into a UMD wrapper and should be safe
35
- to use with ECMAscript modules and AMD/Require.js. CSS bundle is
36
- using CSS modules and shouldn't be breaking CSS of your webpage.
37
-
38
- ## Parameters
31
+ ` <script type="text/javascript" src="/rnacentral-sequence-search-embed/dist/RNAcentral-sequence-search.js"></script> `
39
32
40
- SequenceSearch component accepts a number of parameters. You pass them as html attributes
41
- in curly braces:
33
+ To use it just insert an html tag somewhere in your html:
42
34
43
35
```
44
36
<rnacentral-sequence-search databases='["mirbase"]' />
45
37
```
46
38
39
+ For a minimal example, see [ index.html] ( ./index.html ) .
40
+
41
+
42
+ ## Attributes/parameters
43
+
44
+ Sequence search component accepts a number of attributes. You pass them as html attributes
45
+ and their values are strings (this is a requirement of Web Components):
46
+
47
47
#### databases
48
48
49
49
Array of databases to search query sequence against. Currently you can choose from:
@@ -75,7 +75,9 @@ wormbase |
75
75
76
76
2 . ` npm run serve ` to start a server on http://localhost:8080/
77
77
78
- 3 . ` npm run build ` to generate a new distribution.
78
+ 3 . ` npm run clean ` to clean the dist folder of old assets
79
+
80
+ 4 . ` npm run build ` to generate a new distribution.
79
81
80
82
### Notes
81
83
0 commit comments