Skip to content

Commit e68543b

Browse files
Apply suggestions from code review
Thanks @sofietoft! Co-authored-by: sofietoft <[email protected]>
1 parent 23a118c commit e68543b

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

15/umbraco-cms/reference/umbraco-flavored-markdown.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ The internal working of the `ufm-label-value` component would then be able to ac
4343

4444
In addition, a filter syntax can be applied to UFM contents. This can be useful for formatting or transforming a value without needing to develop your own custom UFM component.
4545

46-
The syntax for UFM filters by using a pipe character `|` (U+007C Vertical Line). Multiple filters may be applied. The value from the previous filter is passed onto the next.
46+
The syntax for UFM filters uses a pipe character `|` (U+007C Vertical Line). Multiple filters may be applied, and the value from the previous filter is passed onto the next.
4747

48-
For example, to display a rich text value, stripping out the HTML markup and limiting it to the first 15 words could use the following filters:
48+
To display a rich text value, stripping out the HTML markup and limiting it to the first 15 words could use the following filters:
4949

5050
```markdown
5151
{umbValue: bodyText | strip-html | word-limit:15}
@@ -58,7 +58,7 @@ A list of available UFM filters is detailed below.
5858

5959
### Available UFM components
6060

61-
As of Umbraco 15.0.0, the following UFM components are available to use.
61+
The following UFM components are available to use.
6262

6363
- Label Value
6464
- Localize
@@ -73,7 +73,7 @@ The Label Value component will render the current value of a given property alia
7373

7474
The alias prefix is `umbValue`. An example of the syntax is `{umbValue: bodyText}`, which would render the component as `<ufm-label-value alias="bodyText"></ufm-label-value>`.
7575

76-
For brevity and backwards-compatibility (with Umbraco 14.1.0), the `=` marker prefix can be used, e.g. `{=bodyText}`.
76+
For brevity and backwards-compatibility, the `=` marker prefix can be used, e.g. `{=bodyText}`.
7777

7878

7979
#### Localize
@@ -82,7 +82,7 @@ The Localize component will render a localization for a given term key.
8282

8383
The alias prefix is `umbLocalize`. An example of the syntax is `{umbLocalize: general_name}`, which would render the component as `<ufm-localize alias="general_name"></ufm-localize>`.
8484

85-
Similarly, for brevity and backwards-compatibility (with Umbraco 14.1.0), the `#` marker prefix can be used, e.g. `{#general_name}`.
85+
Similarly, for brevity and backwards-compatibility, the `#` marker prefix can be used, e.g. `{#general_name}`.
8686

8787

8888
#### Content Name
@@ -96,7 +96,7 @@ As of Umbraco 15.0.0, the Content Name component supports the content-based pick
9696

9797
### Available UFM filters
9898

99-
As of Umbraco 15.0.0, the following UFM filters are available to use.
99+
The following UFM filters are available to use.
100100

101101
| Name | Alias | Example syntax |
102102
| ---------- | ------------ | -------------------------------------- |
@@ -107,7 +107,6 @@ As of Umbraco 15.0.0, the following UFM filters are available to use.
107107
| Uppercase | `uppercase` | `{umbValue: headline | uppercase}` |
108108
| Word Limit | `word-limit` | `{umbValue: intro | word-limit:15}` |
109109

110-
More UFM filters may be available in upcoming Umbraco releases.
111110

112111

113112
### Custom UFM components
@@ -141,12 +140,12 @@ export class MyCustomUfmComponentApi implements UmbUfmComponentBase {
141140
export { MyCustomUfmComponentApi as api };
142141
```
143142

144-
Using the syntax `{myCustom: myCustomText}` would render the markup `<ufm-custom-component text="myCustomText"></ufm-custom-component>`. Then inside the `ufm-custom-component` component code, you can perform any logic to render your required markup.
143+
Using the `{myCustom: myCustomText}` syntax would render the following markup: `<ufm-custom-component text="myCustomText"></ufm-custom-component>`. Inside the `ufm-custom-component` component code, you can perform any logic to render your required markup.
145144

146145

147146
### Custom UFM filters
148147

149-
If you wish to develop your own custom UFM filter, you can use the `ufmFilter` extension type:
148+
If you wish to develop custom UFM filter, you can use the `ufmFilter` extension type:
150149

151150
```json
152151
{
@@ -174,7 +173,7 @@ class UmbUfmReverseFilterApi extends UmbUfmFilterBase {
174173
export { UmbUfmReverseFilterApi as api };
175174
```
176175
177-
Using the syntax `{umbValue: headline | reverse}`, e.g. where `headline` having a value of `Hello world` would be transform to `dlrow olleH`.
176+
Using the `{umbValue: headline | reverse}` syntax where `headline` having a value of `Hello world` would be transformed to `dlrow olleH`.
178177
179178
180179
## Post-processing and sanitization
@@ -190,7 +189,7 @@ The sanitized markup will be...
190189
- Only web components that have a prefix of `ufm-`, `umb-` or `uui-` will be allowed to render
191190
192191
193-
## Rendering UFM in your own components
192+
## Rendering UFM in custom components
194193
195194
If you would like to render UFM within your own web components in the Umbraco CMS backoffice, you can use the `umb-ufm-render` component:
196195

0 commit comments

Comments
 (0)