Skip to content

Commit 0ad67ca

Browse files
committed
Small documentation updates
1 parent 4ae5db4 commit 0ad67ca

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

docs/documentation/docs/controls/TaxonomyPicker.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Taxonomy Picker
22

3-
This control Allows you to select one more more Terms from a termset via its name or termset ID. You can also configure the control to select the child terms from a specific term in the termset by setting the AnchorId.
3+
This control Allows you to select one or more Terms from a TermSet via its name or TermSet ID. You can also configure the control to select the child terms from a specific term in the TermSet by setting the AnchorId.
44

5-
> **Disclaimer**: This control makes use of the `ProcessQuery` API end-points to retrieve the managed metadata information. This will get changed once the APIs for managing managed metadata will become available.
5+
!!! note "Disclaimer"
6+
This control makes use of the `ProcessQuery` API end-points to retrieve the managed metadata information. This will get changed once the APIs for managing managed metadata will become available.
67

78
**Empty term picker**
89

@@ -35,22 +36,21 @@ import { TaxonomyPicker, IPickerTerms } from "@pnp/spfx-controls-react/lib/Taxon
3536
```TypeScript
3637
<TaxonomyPicker
3738
allowMultipleSelections={true}
38-
termsetNameOrID="Countries"
39+
TermSetNameOrID="Countries"
3940
panelTitle="Select Term"
4041
label="Taxonomy Picker"
4142
context={this.props.context}
42-
onChange={this._onTaxPickerChange}
43+
onChange={this.onTaxPickerChange}
4344
isTermSetSelectable={false}
4445
/>
4546
```
4647

4748
- With the `onChange` property you can capture the event of when the terms in the picker has changed:
4849

4950
```typescript
50-
private _onTaxPickerChange(terms : IPickerTerms)
51-
{
52-
console.log("Terms", terms);
53-
}
51+
private onTaxPickerChange(terms : IPickerTerms) {
52+
console.log("Terms", terms);
53+
}
5454
```
5555

5656
## Implementation
@@ -65,10 +65,10 @@ The TaxonomyPicker control can be configured with the following properties:
6565
| context | WebPartContext | yes | Context of the current web part. |
6666
| initialValues | IPickerTerms | no | Defines the selected by default term sets. |
6767
| allowMultipleSelections | boolean | no | Defines if the user can select only one or many term sets. Default value is false. |
68-
| termsetNameOrID | string | yes | The name or Id of your TermSet that you would like the Taxonomy Picker to chose terms from. |
68+
| TermSetNameOrID | string | yes | The name or Id of your TermSet that you would like the Taxonomy Picker to chose terms from. |
6969
| onChange | function | no | captures the event of when the terms in the picker has changed. |
70-
| isTermSetSelectable | boolean | no | Specify if the term set itself is selectable in the tree view. |
71-
| anchorId | string | no | Set the anchorid to a child term in the termset to be able to select terms from that level and below. |
70+
| isTermSetSelectable | boolean | no | Specify if the TermSet itself is selectable in the tree view. |
71+
| anchorId | string | no | Set the anchorid to a child term in the TermSet to be able to select terms from that level and below. |
7272

7373
Interface `IPickerTerm`
7474

@@ -77,8 +77,8 @@ Interface `IPickerTerm`
7777
| key | string | yes | The ID of the term |
7878
| name | string | yes | The name of the term |
7979
| path | string | yes | The path of the term |
80-
| termSet | string | yes | The Id of the parent term set of the term |
81-
| termSetName | string | no | The Name of the parent term set of the term |
80+
| termSet | string | yes | The Id of the parent TermSet of the term |
81+
| termSetName | string | no | The Name of the parent TermSet of the term |
8282

8383
Interface `IPickerTerms`
8484

docs/documentation/docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ The following controls are currently available:
3939

4040
Field customizer controls:
4141

42-
> **Note**: If you want to use these controls in your solution, first check out the start guide for these controls: [using the field controls](./controls/fields/main).
42+
!!! note
43+
If you want to use these controls in your solution, first check out the start guide for these controls: [using the field controls](./controls/fields/main).
4344

4445
- [FieldAttachmentsRenderer](./controls/fields/FieldAttachmentsRenderer) (renders Clip icon based on the provided `count` property is defined and greater than 0)
4546
- [FieldDateRenderer](./controls/fields/FieldDateRenderer) (renders date string as a simple text)

0 commit comments

Comments
 (0)