aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files/js/breadcrumb.js
blob: 21010c7dc1196ace0742b049bdd60bc2fe5b93ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
/**
* ownCloud
*
* @author Vincent Petry
* @copyright 2014 Vincent Petry <pvince81@owncloud.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*
*/

/* global OC */
/* global SVGSupport, replaceSVG */
(function() {
	/**
	 * Creates an breadcrumb element in the given container
	 */
	var BreadCrumb = function(options){
		this.$el = $('<div class="breadcrumb"></div>');
		options = options || {};
		if (options.onClick) {
			this.onClick = options.onClick;
		}
		if (options.onDrop) {
			this.onDrop = options.onDrop;
		}
		if (options.getCrumbUrl) {
			this.getCrumbUrl = options.getCrumbUrl;
		}
	};
	BreadCrumb.prototype = {
		$el: null,
		dir: null,

		lastWidth: 0,
		hiddenBreadcrumbs: 0,
		totalWidth: 0,
		breadcrumbs: [],
		onClick: null,
		onDrop: null,

		/**
		 * Sets the directory to be displayed as breadcrumb.
		 * This will re-render the breadcrumb.
		 * @param dir path to be displayed as breadcrumb
		 */
		setDirectory: function(dir) {
			dir = dir || '/';
			if (dir !== this.dir) {
				this.dir = dir;
				this.render();
			}
		},

		/**
		 * Returns the full URL to the given directory
		 * @param part crumb data as map
		 * @param index crumb index
		 * @return full URL
		 */
		getCrumbUrl: function(part, index) {
			return '#';
		},

		/**
		 * Renders the breadcrumb elements
		 */
		render: function() {
			var parts = this._makeCrumbs(this.dir || '/');
			var $crumb;
			this.$el.empty();
			this.breadcrumbs = [];

			for (var i = 0; i < parts.length; i++) {
				var part = parts[i];
				var $image;
				var $link = $('<a></a>').attr('href', this.getCrumbUrl(part, i));
				$link.text(part.name);
				$crumb = $('<div class="crumb"></div>');
				$crumb.append($link);
				$crumb.attr('data-dir', part.dir);

				if (part.img) {
					$image = $('<img class="svg"></img>');
					$image.attr('src', part.img);
					$link.append($image);
				}
				this.breadcrumbs.push($crumb);
				this.$el.append($crumb);
				if (this.onClick) {
					$crumb.on('click', this.onClick);
				}
			}
			$crumb.addClass('last');

			// in case svg is not supported by the browser we need to execute the fallback mechanism
			if (!SVGSupport()) {
				replaceSVG();
			}

			// setup drag and drop
			if (this.onDrop) {
				this.$el.find('.crumb:not(.last)').droppable({
					drop: this.onDrop,
					tolerance: 'pointer'
				});
			}

			this._updateTotalWidth();
			this.resize($(window).width(), true);
		},

		/**
		 * Makes a breadcrumb structure based on the given path
		 * @param dir path to split into a breadcrumb structure
		 * @return array of map {dir: path, name: displayName}
		 */
		_makeCrumbs: function(dir) {
			var crumbs = [];
			var pathToHere = '';
			// trim leading and trailing slashes
			dir = dir.replace(/^\/+|\/+$/g, '');
			var parts = dir.split('/');
			if (dir === '') {
				parts = [];
			}
			// root part
			crumbs.push({
				dir: '/',
				name: '',
				img: OC.imagePath('core', 'places/home.svg')
			});
			for (var i = 0; i < parts.length; i++) {
				var part = parts[i];
				pathToHere = pathToHere + '/' + part;
				crumbs.push({
					dir: pathToHere,
					name: part
				});
			}
			return crumbs;
		},

		_updateTotalWidth: function () {
			var self = this;

			this.lastWidth = 0;

			// initialize with some extra space
			this.totalWidth = 64;
			// FIXME: this class should not know about global elements
			if ( $('#navigation').length ) {
				this.totalWidth += $('#navigation').get(0).offsetWidth;
			}
			this.hiddenBreadcrumbs = 0;

			for (var i = 0; i < this.breadcrumbs.length; i++ ) {
				this.totalWidth += $(this.breadcrumbs[i]).get(0).offsetWidth;
			}

			$.each($('#controls .actions>div'), function(index, action) {
				self.totalWidth += $(action).get(0).offsetWidth;
			});

		},

		/**
		 * Show/hide breadcrumbs to fit the given width
		 */
		resize: function (width, firstRun) {
			var i, $crumb;

			if (width === this.lastWidth) {
				return;
			}

			// window was shrinked since last time or first run ?
			if ((width < this.lastWidth || firstRun) && width < this.totalWidth) {
				if (this.hiddenBreadcrumbs === 0 && this.breadcrumbs.length > 1) {
					// start by hiding the first breadcrumb after home,
					// that one will have extra three dots displayed
					$crumb = this.breadcrumbs[1];
					this.totalWidth -= $crumb.get(0).offsetWidth;
					$crumb.find('a').addClass('hidden');
					$crumb.append('<span class="ellipsis">...</span>');
					this.totalWidth += $crumb.get(0).offsetWidth;
					this.hiddenBreadcrumbs = 2;
				}
				i = this.hiddenBreadcrumbs;
				// hide subsequent breadcrumbs if the space is still not enough
				while (width < this.totalWidth && i > 1 && i < this.breadcrumbs.length - 1) {
					$crumb = this.breadcrumbs[i];
					this.totalWidth -= $crumb.get(0).offsetWidth;
					$crumb.addClass('hidden');
					this.hiddenBreadcrumbs = i;
					i++;
				}
			// window is bigger than last time
			} else if (width > this.lastWidth && this.hiddenBreadcrumbs > 0) {
				i = this.hiddenBreadcrumbs;
				while (width > this.totalWidth && i > 0) {
					if (this.hiddenBreadcrumbs === 1) {
						// special handling for last one as it has the three dots
						$crumb = this.breadcrumbs[1];
						if ($crumb) {
							this.totalWidth -= $crumb.get(0).offsetWidth;
							$crumb.find('.ellipsis').remove();
							$crumb.find('a').removeClass('hidden');
							this.totalWidth += $crumb.get(0).offsetWidth;
						}
					} else {
						$crumb = this.breadcrumbs[i];
						$crumb.removeClass('hidden');
						this.totalWidth += $crumb.get(0).offsetWidth;
						if (this.totalWidth > width) {
							this.totalWidth -= $crumb.get(0).offsetWidth;
							$crumb.addClass('hidden');
							break;
						}
					}
					i--;
					this.hiddenBreadcrumbs = i;
				}
			}

			this.lastWidth = width;
		}
	};

	window.BreadCrumb = BreadCrumb;
})();