Skip to content

Commit c63755a

Browse files
committed
Add info about customisation - #12
1 parent f607fef commit c63755a

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

+32-2
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,20 @@ If you want to hide one specific facet, use:
5050
You can hide any facet - ` "rna_type", "TAXONOMY", "expert_db", "qc_warning_found", "has_go_annotations",
5151
"has_conserved_structure", "has_genomic_coordinates" `
5252

53-
For a minimal example, see [index.html](./index.html). For an Rfam example, see [rfam.html](./rfam.html).
53+
You can also customise some elements of this embeddable component. See what you can change [here](#layout).
54+
The example below changes the color of the buttons:
55+
56+
```
57+
<rnacentral-sequence-search
58+
databases='["miRBase"]'
59+
customStyle='{
60+
"submitButtonColor": "#007c82",
61+
"clearButtonColor": "#6c757d"
62+
}'
63+
/>
64+
```
5465

55-
To change the layout, you will need to edit this file: [index.scss](./src/index.scss)
66+
For a minimal example, see [index.html](./index.html). For an Rfam example, see [rfam.html](./rfam.html).
5667

5768
## Attributes/parameters
5869

@@ -101,6 +112,25 @@ tmrna_web |
101112
wormbase |
102113
zwd |
103114

115+
#### layout
116+
117+
Parameters that you can use to customise some elements of this embeddable component
118+
119+
parameter | description |
120+
------------------|-----------------------------------------------------------------------------------|
121+
h1Color | change the color of the `Search in miRBase` text |
122+
h1Size | change the size of the `Search in miRBase` text |
123+
h2Color | change the color of the `Similar sequences` and `Rfam classification` text |
124+
h2Size | change the size of the `Similar sequences` and `Rfam classification` text |
125+
facetColor | change the color of the facet title |
126+
facetSize | change the size of the facet title |
127+
seqTitleColor | used in results, it changes the color of the title |
128+
seqTitleSize | used in results, it changes the size of the title |
129+
seqInfoColor | used in results, it changes the color of the `URS and number of nucleotides` text |
130+
seqInfoSize | used in results, it changes the size of the `URS and number of nucleotides` text |
131+
submitButtonColor | change the color of the `Submit` button |
132+
clearButtonColor | change the color of the `Clear sequence` button |
133+
104134
## Developer details
105135

106136
### Local development

0 commit comments

Comments
 (0)