Skip to content

Commit

Permalink
Update API docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Automated Build committed Oct 21, 2024
1 parent 8987ca1 commit 219b5a3
Show file tree
Hide file tree
Showing 242 changed files with 4,161 additions and 2,804 deletions.
2 changes: 1 addition & 1 deletion ref-docs/sitecore-jss-angular-schematics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@

#### Defined in

[index.ts:41](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
[index.ts:41](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
7 changes: 5 additions & 2 deletions ref-docs/sitecore-jss-angular/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
- [ImageDirective](classes/ImageDirective.md)
- [JssModule](classes/JssModule.md)
- [LinkDirective](classes/LinkDirective.md)
- [MemoryCacheClient](classes/MemoryCacheClient.md)
- [PlaceholderComponent](classes/PlaceholderComponent.md)
- [PlaceholderLoadingDirective](classes/PlaceholderLoadingDirective.md)
- [RenderComponentComponent](classes/RenderComponentComponent.md)
Expand All @@ -39,6 +40,8 @@

### Interfaces

- [CacheClient](interfaces/CacheClient.md)
- [CacheOptions](interfaces/CacheOptions.md)
- [CampaignInstance](interfaces/CampaignInstance.md)
- [ComponentFields](interfaces/ComponentFields.md)
- [ComponentNameAndModule](interfaces/ComponentNameAndModule.md)
Expand Down Expand Up @@ -234,7 +237,7 @@ packages/sitecore-jss/types/editing/edit-frame.d.ts:57

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:65](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L65)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:65](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L65)

___

Expand Down Expand Up @@ -443,7 +446,7 @@ rendering is HtmlElementRendering

#### Defined in

[packages/sitecore-jss-angular/src/components/rendering.ts:6](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/rendering.ts#L6)
[packages/sitecore-jss-angular/src/components/rendering.ts:6](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/rendering.ts#L6)

___

Expand Down
8 changes: 4 additions & 4 deletions ref-docs/sitecore-jss-angular/classes/ComponentNameAndType.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:12](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L12)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:12](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L12)

___

Expand All @@ -41,7 +41,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:9](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L9)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:9](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L9)

___

Expand All @@ -55,7 +55,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:17](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L17)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:17](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L17)

___

Expand All @@ -65,4 +65,4 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:10](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L10)
[packages/sitecore-jss-angular/src/services/placeholder.token.ts:10](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L10)
24 changes: 12 additions & 12 deletions ref-docs/sitecore-jss-angular/classes/DateDirective.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:29](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L29)
[packages/sitecore-jss-angular/src/components/date.directive.ts:29](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L29)

## Properties

Expand All @@ -55,7 +55,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:32](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L32)
[packages/sitecore-jss-angular/src/components/date.directive.ts:32](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L32)

___

Expand All @@ -65,7 +65,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:23](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L23)
[packages/sitecore-jss-angular/src/components/date.directive.ts:23](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L23)

___

Expand All @@ -75,7 +75,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:25](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L25)
[packages/sitecore-jss-angular/src/components/date.directive.ts:25](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L25)

___

Expand All @@ -85,7 +85,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:17](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L17)
[packages/sitecore-jss-angular/src/components/date.directive.ts:17](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L17)

___

Expand All @@ -95,7 +95,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:21](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L21)
[packages/sitecore-jss-angular/src/components/date.directive.ts:21](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L21)

___

Expand All @@ -105,7 +105,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:31](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L31)
[packages/sitecore-jss-angular/src/components/date.directive.ts:31](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L31)

___

Expand All @@ -115,7 +115,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:19](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L19)
[packages/sitecore-jss-angular/src/components/date.directive.ts:19](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L19)

___

Expand All @@ -125,7 +125,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:30](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L30)
[packages/sitecore-jss-angular/src/components/date.directive.ts:30](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L30)

___

Expand All @@ -135,7 +135,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:27](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L27)
[packages/sitecore-jss-angular/src/components/date.directive.ts:27](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L27)

## Methods

Expand All @@ -159,7 +159,7 @@ OnChanges.ngOnChanges

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:35](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L35)
[packages/sitecore-jss-angular/src/components/date.directive.ts:35](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L35)

___

Expand All @@ -173,4 +173,4 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:46](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/date.directive.ts#L46)
[packages/sitecore-jss-angular/src/components/date.directive.ts:46](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/date.directive.ts#L46)
24 changes: 12 additions & 12 deletions ref-docs/sitecore-jss-angular/classes/EditFrameComponent.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:32](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L32)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:32](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L32)

___

Expand All @@ -54,7 +54,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:48](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L48)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:48](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L48)

___

Expand All @@ -64,7 +64,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:38](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L38)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:38](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L38)

___

Expand All @@ -74,7 +74,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:30](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L30)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:30](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L30)

___

Expand All @@ -84,7 +84,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:47](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L47)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:47](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L47)

___

Expand All @@ -94,7 +94,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:46](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L46)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:46](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L46)

___

Expand All @@ -104,7 +104,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:40](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L40)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:40](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L40)

___

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:42](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L42)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:42](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L42)

___

Expand All @@ -124,7 +124,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:34](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L34)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:34](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L34)

___

Expand All @@ -134,7 +134,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:36](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L36)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:36](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L36)

## Methods

Expand All @@ -148,7 +148,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:72](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L72)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:72](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L72)

___

Expand All @@ -166,4 +166,4 @@ OnChanges.ngOnChanges

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:50](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/editframe.component.ts#L50)
[packages/sitecore-jss-angular/src/components/editframe.component.ts:50](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/editframe.component.ts#L50)
14 changes: 7 additions & 7 deletions ref-docs/sitecore-jss-angular/classes/FileDirective.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ File fields cannot be managed via the EE. We never output "editable."

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)
[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)

## Properties

Expand All @@ -51,7 +51,7 @@ File fields cannot be managed via the EE. We never output "editable."

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:17](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L17)
[packages/sitecore-jss-angular/src/components/file.directive.ts:17](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L17)

___

Expand All @@ -61,7 +61,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)
[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)

___

Expand All @@ -71,7 +71,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)
[packages/sitecore-jss-angular/src/components/file.directive.ts:21](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)

___

Expand All @@ -81,7 +81,7 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:19](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L19)
[packages/sitecore-jss-angular/src/components/file.directive.ts:19](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L19)

## Methods

Expand All @@ -105,7 +105,7 @@ OnChanges.ngOnChanges

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:23](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L23)
[packages/sitecore-jss-angular/src/components/file.directive.ts:23](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L23)

___

Expand All @@ -119,4 +119,4 @@ ___

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:34](https://github.com/Sitecore/jss/blob/fed0b75cb/packages/sitecore-jss-angular/src/components/file.directive.ts#L34)
[packages/sitecore-jss-angular/src/components/file.directive.ts:34](https://github.com/Sitecore/jss/blob/8987ca112/packages/sitecore-jss-angular/src/components/file.directive.ts#L34)
Loading

0 comments on commit 219b5a3

Please sign in to comment.