├── .gitignore ├── .npmignore ├── LICENSE.md ├── README.md ├── bower.json ├── demo ├── LICENSE.txt ├── assets │ ├── css │ │ ├── font-awesome.min.css │ │ ├── images │ │ │ ├── overlay.png │ │ │ ├── pattern-size1.svg │ │ │ ├── pattern-size2.svg │ │ │ └── pattern-size3.svg │ │ └── main.css │ ├── fonts │ │ ├── FontAwesome.otf │ │ ├── fontawesome-webfont.eot │ │ ├── fontawesome-webfont.svg │ │ ├── fontawesome-webfont.ttf │ │ ├── fontawesome-webfont.woff │ │ └── fontawesome-webfont.woff2 │ ├── js │ │ ├── jquery.min.js │ │ ├── jquery.scrolly.min.js │ │ ├── main.js │ │ ├── skel.min.js │ │ └── util.js │ └── sass │ │ ├── base │ │ ├── _page.scss │ │ └── _typography.scss │ │ ├── components │ │ ├── _box.scss │ │ ├── _button.scss │ │ ├── _form.scss │ │ ├── _icon.scss │ │ ├── _image.scss │ │ ├── _list.scss │ │ ├── _section.scss │ │ ├── _spotlight.scss │ │ ├── _table.scss │ │ └── _wrapper.scss │ │ ├── ie8.scss │ │ ├── ie9.scss │ │ ├── layout │ │ ├── _footer.scss │ │ ├── _header.scss │ │ └── _main.scss │ │ ├── libs │ │ ├── _functions.scss │ │ ├── _mixins.scss │ │ ├── _skel.scss │ │ └── _vars.scss │ │ └── main.scss ├── images │ ├── bg.jpg │ ├── pic01.jpg │ ├── pic02.jpg │ ├── pic03.jpg │ ├── pic04.jpg │ ├── pic05.jpg │ └── screen.jpg └── index.html ├── gulpfile.js ├── index.html ├── package.json ├── publishing-material ├── documentation-source-files │ ├── MANUAL.html │ ├── highlight.default.min.css │ └── highlight.min.js ├── media-source-files │ ├── accurate-text-off-tr.png │ ├── accurate-text-on-tr.png │ ├── autohide-small.mp4 │ ├── dark-theme.png │ ├── panels.html │ ├── random_grey_variations.png │ ├── style.css │ └── xivmap1.png └── media │ ├── ss1.png │ ├── ss2.png │ ├── ss3.png │ ├── xivmap-accurate-text.png │ ├── xivmap-autohide.gif │ ├── xivmap-demo.gif │ ├── xivmap-demo.mp4 │ ├── xivmap-light-dark-theme.png │ ├── xivmap-preview.jpg │ └── xivmap-thumbnail.png ├── xivmap-docked.css ├── xivmap.css └── xivmap.js /.gitignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | /.gh-pages 3 | /dist 4 | /packaged 5 | /node_modules 6 | /bower_components -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | /.idea 2 | /.gitignore 3 | /.gh-pages 4 | /dist 5 | /publishing-material 6 | /demo 7 | /index.html 8 | /bower.json 9 | /node_modules 10 | /bower_components 11 | /gulpfile.js 12 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Andrea Stella 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A minimap for websites, a la Sublime Text 2 | 3 |  4 | 5 | For a live demo please refer to [this page](http://codecanyon.net/item/xivmap-website-minimap-jquery-vanilla-js/full_screen_preview/13341416). 6 | 7 | Let's jump right in with an example: 8 | 9 | ```html 10 | 11 |
12 |Sample content
23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | ``` 33 | 34 | ## Files 35 | Xivmap is composed of three files: 36 | - `xivmap.js` 37 | - `xivmap.css` 38 | - `xivmap-docked.css` (optional) 39 | 40 | Minified files are also provided, they should be used if you don't have a build process set up 41 | - `xivmap.min.js` 42 | - `xivmap.min.css` 43 | - `xivmap-docked.min.css` (optional) 44 | 45 | To use Xivmap, you need to add four things to your page: the two required files, a container for xivmap to use, and a line of JavaScript to start it up. 46 | 47 | ## CSS Classes 48 | You should add one of the positioning classes to your xivmap container, one animation class is also recommended. 49 | 50 | ###### Positioning classes 51 | `top-right`, `right`, `bottom-right` 52 | `top-left`, `left`, `bottom-left` 53 | 54 | ###### Animation classes 55 | `slide-in`, `fade-in` 56 | 57 | ## jQuery version 58 | Xivmap uses a hybrid model, both the jQuery and vanilla JavaScript versions are available in the same file. If jQuery is detected as being available, Xivmap will add its function to it. 59 | For the examples on this page, simply replace the calls to `xivmap()` with `$('.xvmap').xivmap()` 60 | 61 | 62 | ## Short Instructions 63 | - Include `xivmap.js` as a script tag. 64 | - Include `xivmap.css` as a stylesheet. 65 | - Create a div with the class `xivmap` and one of the positioning classes. 66 | - Tip: add the class `slide-in` or `fade-in` to it in order to add animations. 67 | - Tip: place this div near the end of the `` tag, after all your other content. This will make sure that it remains on top. If you don't do this, you might need to add `z-index` values through CSS. 68 | - inside a ` 80 | 81 | 82 |Sample content
84 | 85 |