Skip to content

Commit

Permalink
feat($breadcrumb): Support url params when using `ncyBreadcrumb.paren…
Browse files Browse the repository at this point in the history 
…t` property

The state-specific option `ncyBreadcrumb.parent` supports now url params.
It allows specifying parent with the same syntax as the UI-router's
`ui-sref` either with a string value or with a function value :
```
ncyBreadcrumb: {
  parent: 'contact.detail({idContact: 42})'
}
```

The option prefixStateName have also the same syntax.

Closes #46
  • Loading branch information
@ncuillery
ncuillery committed Oct 15, 2014
1 parent ada0901 commit 5573004
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 45 deletions.
58 changes: 36 additions & 22 deletions dist/angular-breadcrumb.js
View file
@@ -1,4 +1,4 @@
/*! angular-breadcrumb - v0.2.3-dev-2014-10-12
/*! angular-breadcrumb - v0.2.3-dev-2014-10-15
* https://github.com/ncuillery/angular-breadcrumb
* Copyright (c) 2014 Nicolas Cuillery; Licensed MIT */

Expand All @@ -11,6 +11,12 @@ function isAOlderThanB(scopeA, scopeB) {
}
}

function parseStateRef(ref) {
var parsed = ref.replace(/\n/g, " ").match(/^([^(]+?)\s*(\((.*)\))?$/);
if (!parsed || parsed.length !== 4) { throw new Error("Invalid state ref '" + ref + "'"); }
return { state: parsed[1], paramExpr: parsed[3] || null };
}

function $Breadcrumb() {

var $$options = {
Expand Down Expand Up @@ -40,34 +46,47 @@ function $Breadcrumb() {
// Check if state has explicit parent OR we try guess parent from its name
var name = state.parent || (/^(.+)\.[^.]+$/.exec(state.name) || [])[1];
// If we were able to figure out parent name then get this state
return name && $state.get(name);
return name;
};

// Add the state in the chain if not already in and if not abstract
var $$addStateInChain = function(chain, state) {
var $$addStateInChain = function(chain, stateRef) {
var conf,
parentParams,
ref = parseStateRef(stateRef);

for(var i=0, l=chain.length; i<l; i+=1) {
if (chain[i].name === state.name) {
if (chain[i].name === ref.state) {
return;
}
}

if(!state.abstract && !(state.ncyBreadcrumb && state.ncyBreadcrumb.skip)) {
state.ncyBreadcrumbLink = $state.href(state.name, $stateParams || {});
chain.unshift(state);
conf = $state.get(ref.state);
if(!conf.abstract && !(conf.ncyBreadcrumb && conf.ncyBreadcrumb.skip)) {
if(ref.paramExpr) {
parentParams = $lastViewScope.$eval(ref.paramExpr);
}

conf.ncyBreadcrumbLink = $state.href(ref.state, parentParams || $stateParams || {});
chain.unshift(conf);
}
};

// Get the state for the parent step in the breadcrumb
var $$breadcrumbParentState = function(state) {
if(state.ncyBreadcrumb && state.ncyBreadcrumb.parent) {
var isFunction = typeof state.ncyBreadcrumb.parent === 'function';
var stateParent = isFunction ? state.ncyBreadcrumb.parent($lastViewScope) : state.ncyBreadcrumb.parent;
if(stateParent) {
return $state.get(stateParent);
var $$breadcrumbParentState = function(stateRef) {
var ref = parseStateRef(stateRef),
conf = $state.get(ref.state);

if(conf.ncyBreadcrumb && conf.ncyBreadcrumb.parent) {
// Handle the "parent" property of the breadcrumb, override the parent/child relation of the state
var isFunction = typeof conf.ncyBreadcrumb.parent === 'function';
var parentStateRef = isFunction ? conf.ncyBreadcrumb.parent($lastViewScope) : conf.ncyBreadcrumb.parent;
if(parentStateRef) {
return parentStateRef;
}
}

return $$parentState(state);
return $$parentState(conf);
};

return {
Expand All @@ -92,18 +111,13 @@ function $Breadcrumb() {
var chain = [];

// From current state to the root
for(var state = $state.$current.self; state && state.name !== ''; state=$$breadcrumbParentState(state)) {
$$addStateInChain(chain, state);
for(var stateRef = $state.$current.self.name; stateRef; stateRef=$$breadcrumbParentState(stateRef)) {
$$addStateInChain(chain, stateRef);
}

// Prefix state treatment
if($$options.prefixStateName) {
var prefixState = $state.get($$options.prefixStateName);
if(!prefixState) {
throw 'Bad configuration : prefixState "' + $$options.prefixStateName + '" unknown';
}

$$addStateInChain(chain, prefixState);
$$addStateInChain(chain, $$options.prefixStateName);
}

return chain;
Expand Down
4 changes: 2 additions & 2 deletions dist/angular-breadcrumb.min.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 35 additions & 21 deletions src/angular-breadcrumb.js
View file
Expand Up @@ -6,6 +6,12 @@ function isAOlderThanB(scopeA, scopeB) {
}
}

function parseStateRef(ref) {
var parsed = ref.replace(/\n/g, " ").match(/^([^(]+?)\s*(\((.*)\))?$/);
if (!parsed || parsed.length !== 4) { throw new Error("Invalid state ref '" + ref + "'"); }
return { state: parsed[1], paramExpr: parsed[3] || null };
}

function $Breadcrumb() {

var $$options = {
Expand Down Expand Up @@ -35,34 +41,47 @@ function $Breadcrumb() {
// Check if state has explicit parent OR we try guess parent from its name
var name = state.parent || (/^(.+)\.[^.]+$/.exec(state.name) || [])[1];
// If we were able to figure out parent name then get this state
return name && $state.get(name);
return name;
};

// Add the state in the chain if not already in and if not abstract
var $$addStateInChain = function(chain, state) {
var $$addStateInChain = function(chain, stateRef) {
var conf,
parentParams,
ref = parseStateRef(stateRef);

for(var i=0, l=chain.length; i<l; i+=1) {
if (chain[i].name === state.name) {
if (chain[i].name === ref.state) {
return;
}
}

if(!state.abstract && !(state.ncyBreadcrumb && state.ncyBreadcrumb.skip)) {
state.ncyBreadcrumbLink = $state.href(state.name, $stateParams || {});
chain.unshift(state);
conf = $state.get(ref.state);
if(!conf.abstract && !(conf.ncyBreadcrumb && conf.ncyBreadcrumb.skip)) {
if(ref.paramExpr) {
parentParams = $lastViewScope.$eval(ref.paramExpr);
}

conf.ncyBreadcrumbLink = $state.href(ref.state, parentParams || $stateParams || {});
chain.unshift(conf);
}
};

// Get the state for the parent step in the breadcrumb
var $$breadcrumbParentState = function(state) {
if(state.ncyBreadcrumb && state.ncyBreadcrumb.parent) {
var isFunction = typeof state.ncyBreadcrumb.parent === 'function';
var stateParent = isFunction ? state.ncyBreadcrumb.parent($lastViewScope) : state.ncyBreadcrumb.parent;
if(stateParent) {
return $state.get(stateParent);
var $$breadcrumbParentState = function(stateRef) {
var ref = parseStateRef(stateRef),
conf = $state.get(ref.state);

if(conf.ncyBreadcrumb && conf.ncyBreadcrumb.parent) {
// Handle the "parent" property of the breadcrumb, override the parent/child relation of the state
var isFunction = typeof conf.ncyBreadcrumb.parent === 'function';
var parentStateRef = isFunction ? conf.ncyBreadcrumb.parent($lastViewScope) : conf.ncyBreadcrumb.parent;
if(parentStateRef) {
return parentStateRef;
}
}

return $$parentState(state);
return $$parentState(conf);
};

return {
Expand All @@ -87,18 +106,13 @@ function $Breadcrumb() {
var chain = [];

// From current state to the root
for(var state = $state.$current.self; state && state.name !== ''; state=$$breadcrumbParentState(state)) {
$$addStateInChain(chain, state);
for(var stateRef = $state.$current.self.name; stateRef; stateRef=$$breadcrumbParentState(stateRef)) {
$$addStateInChain(chain, stateRef);
}

// Prefix state treatment
if($$options.prefixStateName) {
var prefixState = $state.get($$options.prefixStateName);
if(!prefixState) {
throw 'Bad configuration : prefixState "' + $$options.prefixStateName + '" unknown';
}

$$addStateInChain(chain, prefixState);
$$addStateInChain(chain, $$options.prefixStateName);
}

return chain;
Expand Down

0 comments on commit 5573004

Please sign in to comment.