aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorHsieh Chin Fan <pham@topo.tw>2024-10-09 18:52:23 +0800
committerHsieh Chin Fan <pham@topo.tw>2024-10-09 18:52:23 +0800
commitc7f405be1874b6fee1fd9674dea3208e19aab2ce (patch)
tree8b2d4976e7a08ad0e8ed22d286c0d9f2bd58497b /README.md
parent7bbf4f35d28f2dc0ca1fa31fe156f28f82b61703 (diff)
docs: add example about new layout
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 3296bd5..8fec281 100644
--- a/README.md
+++ b/README.md
@@ -126,14 +126,24 @@ After `generateMaps()`, the container has the following structure:
126 126
127Dumbymap switch layouts by attribute `data-layout` of container. Most of the features are done by pure CSS. 127Dumbymap switch layouts by attribute `data-layout` of container. Most of the features are done by pure CSS.
128 128
129You can add custom layout by options `layouts`: 129You can add custom layout by options `layouts`. For example, the following code add a new layout `sticky` to stick `Showcase` at bottom right corner:
130
131```css
132.Dumby[data-layout='sticky'] {
133 .Showcase {
134 display: block;
135 width: 20vw;
136 height: 40vh;
137 position: absolute;
138 right: 0;
139 bottom: 0;
140 background: red;
141 }
142}
143```
130 144
131```js 145```js
132generateMaps(container, { 146generateMaps(container, { layouts: "sticky" })
133 layouts: [
134 "LAYOUT-NAME"
135 ]
136})
137``` 147```
138 148
139 149