X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=ang%2FcrmRouteBinder.md;h=a297bdc459fb6eceb6df9b03e7c1345e92b334d5;hb=a45ddb787c355312824a7449d618893d0db663be;hp=37003abebc005280c99a98bcf698b177e4222ddf;hpb=9c79310372c68b52331cb879bbb9f1e679c09ac5;p=civicrm-core.git diff --git a/ang/crmRouteBinder.md b/ang/crmRouteBinder.md index 37003abebc..a297bdc459 100644 --- a/ang/crmRouteBinder.md +++ b/ang/crmRouteBinder.md @@ -30,16 +30,18 @@ Things to try out: ## Functions - * `$scope.$bindToRoute(options)` - * The `options` object should contain keys: - * `expr` (string): The name of a scoped variable to sync. - * `param` (string): The name of a query-parameter to sync. (If the `param` is included in the URL, it will initialize the expr.) - * `format` (string): The type of data to put in `param`. May be one of: - * `json` (default): The `param` is JSON, and the `expr` is a decoded object. - * `raw`: The `param` is string, and the `expr` is a string. - * `int`: the `param` is an integer-like string, and the expr is an integer. - * `bool`: The `param` is '0'/'1', and the `expr` is false/true. - * `default` (object): The default data. (If the `param` is not included in the URL, it will initialize the expr.) +**`$scope.$bindToRoute(options)`** +*The `options` object should contain keys:* + + * `expr` (string): The name of a scoped variable to sync. + * `param` (string): The name of a query-parameter to sync. (If the `param` is included in the URL, it will initialize the expr.) + * `format` (string): The type of data to put in `param`. May be one of: + * `json` (default): The `param` is JSON, and the `expr` is a decoded object. + * `raw`: The `param` is string, and the `expr` is a string. + * `int`: the `param` is an integer-like string, and the expr is an integer. + * `bool`: The `param` is '0'/'1', and the `expr` is false/true. + * `default` (object): The default data. (If the `param` is not included in the URL, it will initialize the expr.) + * `deep` (boolean): By default the json format will be watched using a shallow comparison. For nested objects and arrays enable this option. ## Suggested Usage