Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hzik authored Oct 27, 2021
1 parent 7d190d3 commit 76b9fa0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ You need to specify the `repeater` url, `generates_from` and `codename` paramete
"restricted_chars": "[^a-zA-Z0-9]" // default [^a-zA-Z0-9]
}
```
- `repeater` -> A URL of a service you host on your server and that that forwards JSON from Preview API based on "/items?elements.<codename>[contains]=<value>&depth=0" query
- `repeater` -> A URL of a service you host on your server and that forwards JSON from Preview API based on "/items?elements.<codename>[contains]=<value>&depth=0" query
- `generates_from` -> A codename of a source Text element you want your url slug to be generated from
- `codename` -> A codename of your Custom URL Slug element
- `force_uniqueness` -> A true/false value that generates extra postfix to the url slug value in case the url slug is not unique
- `restricted_chars` -> A set of characters (RegEx) you want the url slug to be restricted to

## Saved Value

The value is saved as an array of [<url slug value>, <autogenerated/manual>] so you know whether the value was generated automatically from the source element or whther it was entered manually:
The value is saved as an array of [<url_slug_value>, <autogenerated/manual>] so you know whether the value was generated automatically from the source element or whther it was entered manually:

```json
["abc","[manual]"]
Expand All @@ -52,5 +52,5 @@ Since custom element code needs to be publicly accessible, you can't call Previe

## Disclamer

With this custom element you can't use URLslug macro in Previews url. Please use ItemId or Codename macros instead.
With this custom element you can't use `URLslug` macro in Preview urls. Please use `ItemId` or `Codename` macros instead.

0 comments on commit 76b9fa0

Please sign in to comment.