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 Dec 16, 2024
1 parent 20c3932 commit 5c8934b
Show file tree
Hide file tree
Showing 468 changed files with 2,781 additions and 2,781 deletions.
2 changes: 1 addition & 1 deletion ref-docs/sitecore-jss-angular-schematics/functions/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@

## Defined in

[index.ts:41](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
[index.ts:41](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular-schematics/src/jss-component/index.ts#L41)
4 changes: 2 additions & 2 deletions ref-docs/sitecore-jss-angular/classes/BaseJssState.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/services/jss-state.service.ts:6](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L6)
[packages/sitecore-jss-angular/src/services/jss-state.service.ts:6](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L6)

***

Expand All @@ -44,4 +44,4 @@

#### Defined in

[packages/sitecore-jss-angular/src/services/jss-state.service.ts:9](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L9)
[packages/sitecore-jss-angular/src/services/jss-state.service.ts:9](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/jss-state.service.ts#L9)
8 changes: 4 additions & 4 deletions ref-docs/sitecore-jss-angular/classes/ComponentNameAndType.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Registers a statically loaded component
#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:12](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L12)

***

Expand All @@ -36,7 +36,7 @@ Registers a statically loaded component
#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:9](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L9)

***

Expand All @@ -50,7 +50,7 @@ Registers a statically loaded component

#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:17](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L17)

***

Expand All @@ -60,4 +60,4 @@ Registers a statically loaded component
#### Defined in

[packages/sitecore-jss-angular/src/services/placeholder.token.ts:10](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/services/placeholder.token.ts#L10)
28 changes: 14 additions & 14 deletions ref-docs/sitecore-jss-angular/classes/DateDirective.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:40](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L40)
[packages/sitecore-jss-angular/src/components/date.directive.ts:40](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L40)

## Properties

Expand All @@ -54,7 +54,7 @@ Default component to render in Pages in Metadata edit mode if field value is emp

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:38](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L38)
[packages/sitecore-jss-angular/src/components/date.directive.ts:38](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L38)

***

Expand All @@ -68,7 +68,7 @@ Default component to render in Pages in Metadata edit mode if field value is emp

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:26](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L26)
[packages/sitecore-jss-angular/src/components/date.directive.ts:26](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L26)

***

Expand All @@ -84,7 +84,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:33](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L33)
[packages/sitecore-jss-angular/src/components/date.directive.ts:33](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L33)

***

Expand All @@ -98,7 +98,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:28](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L28)
[packages/sitecore-jss-angular/src/components/date.directive.ts:28](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L28)

***

Expand All @@ -108,7 +108,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty
#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:20](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L20)
[packages/sitecore-jss-angular/src/components/date.directive.ts:20](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L20)

***

Expand All @@ -118,7 +118,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty
#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:24](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L24)
[packages/sitecore-jss-angular/src/components/date.directive.ts:24](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L24)

***

Expand All @@ -128,7 +128,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty
#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:22](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L22)
[packages/sitecore-jss-angular/src/components/date.directive.ts:22](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L22)

***

Expand All @@ -142,7 +142,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty

#### Defined in

[packages/sitecore-jss-angular/src/components/base-field.directive.ts:24](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L24)
[packages/sitecore-jss-angular/src/components/base-field.directive.ts:24](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L24)

***

Expand All @@ -156,7 +156,7 @@ Custom template to render in Pages in Metadata edit mode if field value is empty

#### Defined in

[packages/sitecore-jss-angular/src/components/base-field.directive.ts:12](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L12)
[packages/sitecore-jss-angular/src/components/base-field.directive.ts:12](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L12)

## Methods

Expand Down Expand Up @@ -185,7 +185,7 @@ children are checked.

#### Defined in

[packages/sitecore-jss-angular/src/components/date.directive.ts:49](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/date.directive.ts#L49)
[packages/sitecore-jss-angular/src/components/date.directive.ts:49](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/date.directive.ts#L49)

***

Expand All @@ -205,7 +205,7 @@ Renders the empty field markup which is required by Pages in editMode 'metadata'

#### Defined in

[packages/sitecore-jss-angular/src/components/base-field.directive.ts:37](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L37)
[packages/sitecore-jss-angular/src/components/base-field.directive.ts:37](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L37)

***

Expand All @@ -231,7 +231,7 @@ Renders a metadata chrome marker for the field. Required by Pages in editMode 'm

#### Defined in

[packages/sitecore-jss-angular/src/components/base-field.directive.ts:53](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L53)
[packages/sitecore-jss-angular/src/components/base-field.directive.ts:53](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L53)

***

Expand All @@ -252,4 +252,4 @@ Returns true if we are in edit mode 'chromes' (field.editable is present) or fie

#### Defined in

[packages/sitecore-jss-angular/src/components/base-field.directive.ts:30](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L30)
[packages/sitecore-jss-angular/src/components/base-field.directive.ts:30](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/base-field.directive.ts#L30)
24 changes: 12 additions & 12 deletions ref-docs/sitecore-jss-angular/classes/EditFrameComponent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:32](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L32)

***

Expand All @@ -38,7 +38,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:48](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L48)

***

Expand All @@ -48,7 +48,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:38](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L38)

***

Expand All @@ -58,7 +58,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:30](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L30)

***

Expand All @@ -68,7 +68,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:47](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L47)

***

Expand All @@ -78,7 +78,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:46](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L46)

***

Expand All @@ -88,7 +88,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:40](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L40)

***

Expand All @@ -104,7 +104,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:42](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L42)

***

Expand All @@ -114,7 +114,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:34](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L34)

***

Expand All @@ -124,7 +124,7 @@
#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:36](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L36)

## Methods

Expand All @@ -138,7 +138,7 @@

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:72](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L72)

***

Expand All @@ -161,4 +161,4 @@ children are checked.

#### Defined in

[packages/sitecore-jss-angular/src/components/editframe.component.ts:50](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editframe.component.ts#L50)
4 changes: 2 additions & 2 deletions ref-docs/sitecore-jss-angular/classes/EditingScriptsComponent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Only renders scripts when Metadata mode is used.

#### Defined in

[packages/sitecore-jss-angular/src/components/editing-scripts.component.ts:17](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/editing-scripts.component.ts#L17)
[packages/sitecore-jss-angular/src/components/editing-scripts.component.ts:17](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editing-scripts.component.ts#L17)

## Methods

Expand All @@ -57,4 +57,4 @@ It is invoked only once when the directive is instantiated.

#### Defined in

[packages/sitecore-jss-angular/src/components/editing-scripts.component.ts:23](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/packages/sitecore-jss-angular/src/components/editing-scripts.component.ts#L23)
[packages/sitecore-jss-angular/src/components/editing-scripts.component.ts:23](https://github.com/Sitecore/jss/blob/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/editing-scripts.component.ts#L23)
6 changes: 3 additions & 3 deletions ref-docs/sitecore-jss-angular/classes/FileDirective.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/file.directive.ts#L21)

## Properties

Expand All @@ -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:17](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/file.directive.ts#L17)

## Methods

Expand Down Expand Up @@ -70,4 +70,4 @@ children are checked.

#### Defined in

[packages/sitecore-jss-angular/src/components/file.directive.ts:23](https://github.com/Sitecore/jss/blob/79b72df335ab50517e6c3357c25dd7db1965274d/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/20c393219fcc37eebfc5f9ac86576745ab661982/packages/sitecore-jss-angular/src/components/file.directive.ts#L23)
Loading

0 comments on commit 5c8934b

Please sign in to comment.