@skyux/errors 5.0.0-beta.1 → 5.0.0

package/documentation.json

@@ -0,0 +1,1187 @@
+{
+  "anchorIds": {
+    "ErrorModalConfig": "class-errormodalconfig",
+    "SkyErrorModalService": "class-skyerrormodalservice",
+    "SkyErrorModule": "class-skyerrormodule",
+    "SkyErrorActionComponent": "class-skyerroractioncomponent",
+    "SkyErrorDescriptionComponent": "class-skyerrordescriptioncomponent",
+    "SkyErrorImageComponent": "class-skyerrorimagecomponent",
+    "SkyErrorTitleComponent": "class-skyerrortitlecomponent",
+    "SkyErrorComponent": "class-skyerrorcomponent",
+    "SkyErrorType": "type-alias-skyerrortype"
+  },
+  "typedoc": {
+    "id": 0,
+    "name": "@skyux/errors",
+    "kind": 0,
+    "kindString": "Project",
+    "flags": {},
+    "originalName": "",
+    "children": [
+      {
+        "id": 40,
+        "name": "ErrorModalConfig",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "children": [
+          {
+            "id": 41,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 42,
+                "name": "new ErrorModalConfig",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 40,
+                  "name": "ErrorModalConfig"
+                }
+              }
+            ]
+          },
+          {
+            "id": 45,
+            "name": "errorCloseText",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Specifies a label for the action button that closes the modal error message.",
+              "tags": [
+                {
+                  "tag": "required",
+                  "text": "\n"
+                }
+              ]
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-modal-config.ts",
+                "line": 17,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          },
+          {
+            "id": 44,
+            "name": "errorDescription",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Specifies a description to provide additional details in the modal error message.",
+              "tags": [
+                {
+                  "tag": "required",
+                  "text": "\n"
+                }
+              ]
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-modal-config.ts",
+                "line": 12,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          },
+          {
+            "id": 43,
+            "name": "errorTitle",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Specifies a title to display in the modal error message.",
+              "tags": [
+                {
+                  "tag": "required",
+                  "text": "\n"
+                }
+              ]
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-modal-config.ts",
+                "line": 7,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            }
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              41
+            ]
+          },
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              45,
+              44,
+              43
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-modal-config.ts",
+            "line": 2,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 46,
+        "name": "SkyErrorModalService",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Opens a modal to display a SKY UX-themed error message."
+        },
+        "decorators": [
+          {
+            "name": "Injectable",
+            "type": {
+              "type": "reference",
+              "name": "Injectable"
+            },
+            "arguments": {
+              "options": "{\n  providedIn: 'root'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 47,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-modal.service.ts",
+                "line": 24,
+                "character": 2
+              }
+            ],
+            "signatures": [
+              {
+                "id": 48,
+                "name": "new SkyErrorModalService",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "parameters": [
+                  {
+                    "id": 49,
+                    "name": "modal",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "name": "SkyModalService"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "id": 46,
+                  "name": "SkyErrorModalService"
+                }
+              }
+            ]
+          },
+          {
+            "id": 50,
+            "name": "open",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-modal.service.ts",
+                "line": 30,
+                "character": 9
+              }
+            ],
+            "signatures": [
+              {
+                "id": 51,
+                "name": "open",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Specifies text for the the error message, including title, description, and action label."
+                },
+                "parameters": [
+                  {
+                    "id": 52,
+                    "name": "config",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "id": 40,
+                      "name": "ErrorModalConfig"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              47
+            ]
+          },
+          {
+            "title": "Methods",
+            "kind": 2048,
+            "children": [
+              50
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-modal.service.ts",
+            "line": 23,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 53,
+        "name": "SkyErrorModule",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "decorators": [
+          {
+            "name": "NgModule",
+            "type": {
+              "type": "reference",
+              "name": "NgModule"
+            },
+            "arguments": {
+              "obj": "{\n  declarations: [\n    SkyErrorComponent,\n    SkyErrorImageComponent,\n    SkyErrorTitleComponent,\n    SkyErrorDescriptionComponent,\n    SkyErrorActionComponent,\n    SkyErrorModalFormComponent\n  ],\n  imports: [\n    CommonModule,\n    SkyErrorsResourcesModule,\n    SkyModalModule\n  ],\n  exports: [\n    SkyErrorComponent,\n    SkyErrorImageComponent,\n    SkyErrorTitleComponent,\n    SkyErrorDescriptionComponent,\n    SkyErrorActionComponent\n  ],\n  entryComponents: [\n    SkyErrorModalFormComponent\n  ]\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 54,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 55,
+                "name": "new SkyErrorModule",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 53,
+                  "name": "SkyErrorModule"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              54
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error.module.ts",
+            "line": 66,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 1,
+        "name": "SkyErrorActionComponent",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Specifies an action to include in the error message.\nFor example, you can include a button to reload the page or to refresh data."
+        },
+        "decorators": [
+          {
+            "name": "Component",
+            "type": {
+              "type": "reference",
+              "name": "Component"
+            },
+            "arguments": {
+              "obj": "{\n  selector: 'sky-error-action',\n  template: '<ng-content></ng-content>'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 2,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 3,
+                "name": "SkyErrorActionComponent",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 1,
+                  "name": "SkyErrorActionComponent"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              2
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-action.component.ts",
+            "line": 13,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 4,
+        "name": "SkyErrorDescriptionComponent",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Specifies a description to provide additional details in the error message."
+        },
+        "decorators": [
+          {
+            "name": "Component",
+            "type": {
+              "type": "reference",
+              "name": "Component"
+            },
+            "arguments": {
+              "obj": "{\n  selector: 'sky-error-description',\n  template: '<ng-content></ng-content>'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 5,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 6,
+                "name": "SkyErrorDescriptionComponent",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 4,
+                  "name": "SkyErrorDescriptionComponent"
+                }
+              }
+            ]
+          },
+          {
+            "id": 7,
+            "name": "replaceDefaultDescription",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Indicates whether to replace the default description. If `false`, the description\nfrom this component is added after the default description.",
+              "tags": [
+                {
+                  "tag": "default",
+                  "text": "false\n"
+                }
+              ]
+            },
+            "decorators": [
+              {
+                "name": "Input",
+                "type": {
+                  "type": "reference",
+                  "name": "Input"
+                },
+                "arguments": {}
+              }
+            ],
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-description.component.ts",
+                "line": 20,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "boolean"
+            },
+            "defaultValue": "false"
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              5
+            ]
+          },
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              7
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-description.component.ts",
+            "line": 13,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 8,
+        "name": "SkyErrorImageComponent",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Specifies an image to display in the error message."
+        },
+        "decorators": [
+          {
+            "name": "Component",
+            "type": {
+              "type": "reference",
+              "name": "Component"
+            },
+            "arguments": {
+              "obj": "{\n  selector: 'sky-error-image',\n  template: '<ng-content></ng-content>'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 9,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 10,
+                "name": "SkyErrorImageComponent",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 8,
+                  "name": "SkyErrorImageComponent"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              9
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-image.component.ts",
+            "line": 12,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 11,
+        "name": "SkyErrorTitleComponent",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Specifies a title to display in the error message."
+        },
+        "decorators": [
+          {
+            "name": "Component",
+            "type": {
+              "type": "reference",
+              "name": "Component"
+            },
+            "arguments": {
+              "obj": "{\n  selector: 'sky-error-title',\n  template: '<ng-content></ng-content>'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 12,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "signatures": [
+              {
+                "id": 13,
+                "name": "SkyErrorTitleComponent",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "type": {
+                  "type": "reference",
+                  "id": 11,
+                  "name": "SkyErrorTitleComponent"
+                }
+              }
+            ]
+          },
+          {
+            "id": 14,
+            "name": "replaceDefaultTitle",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Indicates whether to replace the default title. If `false`, the title\nfrom this component is added after the default title.",
+              "tags": [
+                {
+                  "tag": "default",
+                  "text": "false\n"
+                }
+              ]
+            },
+            "decorators": [
+              {
+                "name": "Input",
+                "type": {
+                  "type": "reference",
+                  "name": "Input"
+                },
+                "arguments": {}
+              }
+            ],
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error-title.component.ts",
+                "line": 20,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "boolean"
+            },
+            "defaultValue": "false"
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              12
+            ]
+          },
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              14
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-title.component.ts",
+            "line": 13,
+            "character": 13
+          }
+        ]
+      },
+      {
+        "id": 15,
+        "name": "SkyErrorComponent",
+        "kind": 128,
+        "kindString": "Class",
+        "flags": {},
+        "comment": {
+          "shortText": "Displays a SKY UX-themed error message."
+        },
+        "decorators": [
+          {
+            "name": "Component",
+            "type": {
+              "type": "reference",
+              "name": "Component"
+            },
+            "arguments": {
+              "obj": "{\n  selector: 'sky-error',\n  styleUrls: ['./error.component.scss'],\n  templateUrl: './error.component.html'\n}"
+            }
+          }
+        ],
+        "children": [
+          {
+            "id": 16,
+            "name": "constructor",
+            "kind": 512,
+            "kindString": "Constructor",
+            "flags": {},
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 74,
+                "character": 2
+              }
+            ],
+            "signatures": [
+              {
+                "id": 17,
+                "name": "SkyErrorComponent",
+                "kind": 16384,
+                "kindString": "Constructor signature",
+                "flags": {},
+                "parameters": [
+                  {
+                    "id": 18,
+                    "name": "resourcesService",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "name": "SkyLibResourcesService"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "reference",
+                  "id": 15,
+                  "name": "SkyErrorComponent"
+                }
+              }
+            ]
+          },
+          {
+            "id": 25,
+            "name": "description",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 56,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "defaultValue": "..."
+          },
+          {
+            "id": 23,
+            "name": "showImage",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "comment": {
+              "shortText": "Indicates whether to display the error image.",
+              "tags": [
+                {
+                  "tag": "default",
+                  "text": "true\n"
+                }
+              ]
+            },
+            "decorators": [
+              {
+                "name": "Input",
+                "type": {
+                  "type": "reference",
+                  "name": "Input"
+                },
+                "arguments": {}
+              }
+            ],
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 53,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "boolean"
+            },
+            "defaultValue": "true"
+          },
+          {
+            "id": 24,
+            "name": "title",
+            "kind": 1024,
+            "kindString": "Property",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 55,
+                "character": 9
+              }
+            ],
+            "type": {
+              "type": "intrinsic",
+              "name": "string"
+            },
+            "defaultValue": "..."
+          },
+          {
+            "id": 19,
+            "name": "errorType",
+            "kind": 262144,
+            "kindString": "Accessor",
+            "flags": {
+              "isPublic": true
+            },
+            "decorators": [
+              {
+                "name": "Input",
+                "type": {
+                  "type": "reference",
+                  "name": "Input"
+                },
+                "arguments": {}
+              }
+            ],
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 39,
+                "character": 13
+              }
+            ],
+            "getSignature": [
+              {
+                "id": 20,
+                "name": "errorType",
+                "kind": 524288,
+                "kindString": "Get signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Specifies an error type to use a set of pre-defined values for the image,\ntitle, and description. The valid options are `'broken'`, `'construction'`,\n`'notfound'`, and `'security'`."
+                },
+                "type": {
+                  "type": "reference",
+                  "id": 56,
+                  "name": "SkyErrorType"
+                }
+              }
+            ],
+            "setSignature": [
+              {
+                "id": 21,
+                "name": "errorType",
+                "kind": 1048576,
+                "kindString": "Set signature",
+                "flags": {},
+                "comment": {
+                  "shortText": "Specifies an error type to use a set of pre-defined values for the image,\ntitle, and description. The valid options are `'broken'`, `'construction'`,\n`'notfound'`, and `'security'`."
+                },
+                "parameters": [
+                  {
+                    "id": 22,
+                    "name": "value",
+                    "kind": 32768,
+                    "kindString": "Parameter",
+                    "flags": {},
+                    "type": {
+                      "type": "reference",
+                      "id": 56,
+                      "name": "SkyErrorType"
+                    }
+                  }
+                ],
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          },
+          {
+            "id": 28,
+            "name": "showDescription",
+            "kind": 262144,
+            "kindString": "Accessor",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 62,
+                "character": 13
+              }
+            ],
+            "getSignature": [
+              {
+                "id": 29,
+                "name": "showDescription",
+                "kind": 524288,
+                "kindString": "Get signature",
+                "flags": {},
+                "type": {
+                  "type": "intrinsic",
+                  "name": "boolean"
+                }
+              }
+            ]
+          },
+          {
+            "id": 26,
+            "name": "showTitle",
+            "kind": 262144,
+            "kindString": "Accessor",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 58,
+                "character": 13
+              }
+            ],
+            "getSignature": [
+              {
+                "id": 27,
+                "name": "showTitle",
+                "kind": 524288,
+                "kindString": "Get signature",
+                "flags": {},
+                "type": {
+                  "type": "intrinsic",
+                  "name": "boolean"
+                }
+              }
+            ]
+          },
+          {
+            "id": 33,
+            "name": "ngOnInit",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 78,
+                "character": 9
+              }
+            ],
+            "signatures": [
+              {
+                "id": 34,
+                "name": "ngOnInit",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                },
+                "implementationOf": {
+                  "type": "reference",
+                  "name": "OnInit.ngOnInit"
+                }
+              }
+            ],
+            "implementationOf": {
+              "type": "reference",
+              "name": "OnInit.ngOnInit"
+            }
+          },
+          {
+            "id": 35,
+            "name": "setErrorTypeFields",
+            "kind": 2048,
+            "kindString": "Method",
+            "flags": {
+              "isPublic": true
+            },
+            "sources": [
+              {
+                "fileName": "projects/errors/src/modules/error/error.component.ts",
+                "line": 84,
+                "character": 9
+              }
+            ],
+            "signatures": [
+              {
+                "id": 36,
+                "name": "setErrorTypeFields",
+                "kind": 4096,
+                "kindString": "Call signature",
+                "flags": {},
+                "type": {
+                  "type": "intrinsic",
+                  "name": "void"
+                }
+              }
+            ]
+          }
+        ],
+        "groups": [
+          {
+            "title": "Constructors",
+            "kind": 512,
+            "children": [
+              16
+            ]
+          },
+          {
+            "title": "Properties",
+            "kind": 1024,
+            "children": [
+              25,
+              23,
+              24
+            ]
+          },
+          {
+            "title": "Accessors",
+            "kind": 262144,
+            "children": [
+              19,
+              28,
+              26
+            ]
+          },
+          {
+            "title": "Methods",
+            "kind": 2048,
+            "children": [
+              33,
+              35
+            ]
+          }
+        ],
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error.component.ts",
+            "line": 32,
+            "character": 13
+          }
+        ],
+        "implementedTypes": [
+          {
+            "type": "reference",
+            "name": "OnInit"
+          }
+        ]
+      },
+      {
+        "id": 56,
+        "name": "SkyErrorType",
+        "kind": 4194304,
+        "kindString": "Type alias",
+        "flags": {},
+        "comment": {
+          "shortText": "Specifies which error to display."
+        },
+        "sources": [
+          {
+            "fileName": "projects/errors/src/modules/error/error-type.ts",
+            "line": 4,
+            "character": 12
+          }
+        ],
+        "type": {
+          "type": "union",
+          "types": [
+            {
+              "type": "literal",
+              "value": "broken"
+            },
+            {
+              "type": "literal",
+              "value": "construction"
+            },
+            {
+              "type": "literal",
+              "value": "notfound"
+            },
+            {
+              "type": "literal",
+              "value": "security"
+            }
+          ]
+        }
+      }
+    ],
+    "groups": [
+      {
+        "title": "Classes",
+        "kind": 128,
+        "children": [
+          40,
+          46,
+          53,
+          1,
+          4,
+          8,
+          11,
+          15
+        ]
+      },
+      {
+        "title": "Type aliases",
+        "kind": 4194304,
+        "children": [
+          56
+        ]
+      }
+    ],
+    "sources": [
+      {
+        "fileName": "projects/errors/src/public-api.ts",
+        "line": 1,
+        "character": 0
+      }
+    ]
+  },
+  "codeExamples": [
+    {
+      "fileName": "error-demo.component.html",
+      "filePath": "/projects/errors/documentation/code-examples/error/embedded/error-demo.component.html",
+      "rawContents": "<sky-error\n  errorType=\"broken\"\n>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Try again\n    </button>\n  </sky-error-action>\n</sky-error>\n\n<sky-error\n  errorType=\"notfound\"\n>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Go back\n    </button>\n  </sky-error-action>\n</sky-error>\n\n<sky-error\n  errorType=\"construction\"\n>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Go back\n    </button>\n  </sky-error-action>\n</sky-error>\n\n<sky-error\n  errorType=\"security\"\n>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Go back\n    </button>\n  </sky-error-action>\n</sky-error>\n\n<sky-error>\n  <sky-error-image>\n    <img\n      role=\"presentation\"\n      src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGQAAABeCAYAAADVA7GfAAAH/klEQVR4Ae2daYgcRRTH3/TuTnbcM0QhwRhQ9IsGlICCIaIiiF88ED+IflBEJDHExIAIgucHQYV4Y8hmYw4jMYcgMYdgEJI1goooxnyIopANJiRsdpLdzfRc3fJ6U7M9vX1V1avuauz60l3dVa/ee//pY35T3VOwbduGjJbmn39B/cgIWKdPOxEYCxZA1x3LoOOG6zMaEUAhk4KYJky9+gbUf/zJN/Fdt90KPa+/AtDd7btf543ZE6RWg8kXX4LGr7+F5rXzlpuh9603AYrF0Ha67TR0cyjUn0YDpl5+LVIMtIGCYVtoNEJN6rYzU4KY27YHnqb8EounNOyTpZIZQezz56G6czd3bqu79gD2zUrJjCDmp1vBNk3uvNqVCmDfrJRMCGKdPAm1AweFc4p90UYWSiYEqWwYBrvZFM4n9kUbWSjaC9L8/RjUvz8qnUu0gbZ0L9oLUlk/RJZDSltkTnkMaS1I/fARaBw/7nFZvIq20KbORV9Bmk0whzaR586xKXE9InfIY1BbQWp790Hz1CmPu/JVtIm2dS16CoLfHbZ+pixnju1KRZl9GcNaCmLu2AnW+LhMXKF90TaOoWPRThBRRMKbXF2RinaCmJvFEAmvIA5S2awfUtFKEAeR7BdHJLyi1Pbrh1S0EkQWkfAKoiNS0UYQKkTCK4puSEUbQdLEGmmO7f0AaSEINSLxBhlV1wmppC+IIkQSJYJ3vy5IJXVBVCESb8Kj6roglXQFUYxIokTw7tcBqaQqiGpE4k14VF0HpJKaIA4i2bUnKkeJ708bqXQmHvHlAR1EwklcC93dYMybx+WyNTbGNVuFIZXS2jVc41A1TmUqKSKSiaee4Zq4ULzvXiitXAGF3l6u2O3JSTA/Xg/Vg9/E7lfo6IC+TRvAWLQodh+qhqmcsngRScEwoLRiObcYmCQUsLTqWcAkxy1pIpXEBRFCJLYNhf6+uPmc3a5U4joa0UBaSCVxQUQwhfMIS70+O9Fxt1SrcVu2tRPxtc2AQCVRQeqHR4RnkYhMI2X5sAUFmUYqI8xMIsvkBHEQicTswWpNPCGm2BGCA5pDwwAJzlJJTBBZRGJX+SdaMwVl+iaNVJIRhAKRSBwhtsQR4hwlOAOG8zsT+zDwLhMRhAKRyHzKQfAawpKZJFJRLggVIrGljhDx0x0TJSmkolwQEUTCktC2FHhYh/UXvcti/XHJkIp7m4p1pYJQziKxa+ncZbmTnsQsFaWCVIbkHrRxJwMkLsxS1x+XEw5SwdtghUWZIA4iGZF/0IbFLnXakRCTjc+W9ZGj0Dym7sEfZYJQYwcZQWT6MiHcy8ondA8Rue3iuhJBZBCJ18FWXeLWVQa7tMZ3rahEKvSCyCISV+DuValPuYSYbh/c66qQCrkgsojEHXTbukRSZb+pt/lxuaIKqdAKQoFI/KLH7wESF2aquyyvaypmqZAKQoFIvEGzul0TJ7Yyt8xsfL+lCqRCJggVIvEL3NkmdYRIiBno0PQOaqRCJggZIglIgNRFXQK7BLjT2kyNVEgEoUQkrUi9KzIXdYm+Xjf86pRIhUQQUkTiFzFe1CWSKnNDEOBO22ZKpCItCDUiaYvUVZERBCR+bXS5ELpKhVSkBaFGJIFRa3yEMJ8pciEliBJEwqLzLGVOO1JHl8ePsGrjD3yXitwsFXFBFCGSoIDt8XGwRvlftdE8cQLg0qUgs+TbHaRiWcJ2hSdb177er+RdJEGR2I0GTK5aDZ1LlkBh7mBQs7bt9tgY1H/+BZJ8VzRDKsUH72/zJW5FbLJ1pQIXH39C6esv4gagYztj7lzo374FoFTidk/olKUSkXBHoGEHGaTCLYhyRKJhgkVcEkUq3IKoRiQiwevYRxSpcAmSCCLRMbuCPjlIZXSUqzeXIEkgEi7vNW88/eDPRi4vY9/2JoVIwrwvFIvQtWwpFAZj3vaWy4BIQ2pOV5hDMfYxpNKxeHGM1hz/HzK5crXwsx2xPInRqO/DdyFuYMwcTtmZWPU8q6ay7LzpRuj96P1YY8c6ZSWJSIK8Nq66klsMtIUCYt80Cw9SiRYkYUQSlLhCcU7QrsjtMn0jjcdsYG4cBoiBVCIFSRqRxIwvc82ao/FeTxsuCM4i2bItc8Hr6rCTy4gHf0IFyREJrbRxkEqgIDkioRWDWYtCKoGC5IiEpZB2GYVUfAXJEQmtCF5rYUjFV5AckXhTSFsPQyqzBMFvtvh1Py9qM8CQineUWYKofBjFO/j/ve43S6VNEB0QSZBI1rlzYF+8GLQ7cDv2sc6eDdyf5g4/pDLzm3qzCRNPPp3oxAXeZHQtvR26H3s0/iSH8TKYn++A+tEfeIdKrH3HNQuhb/MwgDF9bLQEqX21Fy6990FijuQDzWTgijXPAZulMi1LjkhmspPCmoNULs/QdwQxv9iVT+lJQQg2pBupGHa5LPSnv8xYvqTJAP7xMmph1PYdcN7jQWM2tyKaAUQqqIVR+/aQqI28H3EGUAvD+vc0sdncnGgGUAsjzs+KogPk/TgzYFlgGAuv5uyVN1eVAdTCKN51pyr7uV3ODKAWRvGhB8Do7+fsmjenzgBq4GhRGBiAnnVvgzGQi0Kd5Lj2MPeoAWrRYlnW3//A5NoXwLpwIa6dvB1BBoyBAehd9w4Y113rWGsJgjXrzBmo7v4S6oe+A6tcJhguNxGUAWNwELruuRvmPPIwGPPnt5q1CdLaiitTU/nR0pYQugoeFdDT42vwP+C9QYr2FdBDAAAAAElFTkSuQmCC'\n    />\n  </sky-error-image>\n  <sky-error-title>\n    Custom error with a custom image.\n  </sky-error-title>\n  <sky-error-description>\n    Custom description.\n  </sky-error-description>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Custom action\n    </button>\n  </sky-error-action>\n</sky-error>\n\n<sky-error\n  errorType=\"broken\"\n>\n  <sky-error-title\n    [replaceDefaultTitle]=\"true\"\n  >\n    Custom error with a default image.\n  </sky-error-title>\n  <sky-error-description\n    [replaceDefaultDescription]=\"true\"\n  >\n    Custom description.\n  </sky-error-description>\n  <sky-error-action>\n    <button\n      class=\"sky-btn sky-btn-link\"\n      type=\"button\"\n      (click)=\"customAction()\"\n    >\n      Custom action\n    </button>\n  </sky-error-action>\n</sky-error>\n"
+    },
+    {
+      "fileName": "error-demo.component.ts",
+      "filePath": "/projects/errors/documentation/code-examples/error/embedded/error-demo.component.ts",
+      "rawContents": "import {\n  Component\n} from '@angular/core';\n\n@Component({\n  selector: 'app-error-demo',\n  templateUrl: './error-demo.component.html',\n  styles: [`\n    ::ng-deep .sky-error {\n      margin: 40px 0;\n    }\n  `]\n})\nexport class ErrorDemoComponent {\n\n  public customAction(): void {\n    alert('action clicked!');\n  }\n\n}\n"
+    },
+    {
+      "fileName": "error-demo.module.ts",
+      "filePath": "/projects/errors/documentation/code-examples/error/embedded/error-demo.module.ts",
+      "rawContents": "import {\n  NgModule\n} from '@angular/core';\n\nimport {\n  CommonModule\n} from '@angular/common';\n\nimport {\n  SkyErrorModule\n} from '@skyux/errors';\n\nimport {\n  ErrorDemoComponent\n} from './error-demo.component';\n\n@NgModule({\n  imports: [\n    CommonModule,\n    SkyErrorModule\n  ],\n  declarations: [\n    ErrorDemoComponent\n  ],\n  exports: [\n    ErrorDemoComponent\n  ]\n})\nexport class ErrorDemoModule { }\n"
+    },
+    {
+      "fileName": "error-demo.component.html",
+      "filePath": "/projects/errors/documentation/code-examples/error/modal/error-demo.component.html",
+      "rawContents": "<button\n  class=\"sky-btn sky-btn-default\"\n  type=\"button\"\n  (click)=\"openErrorModal()\"\n>\n  Open error modal\n</button>\n"
+    },
+    {
+      "fileName": "error-demo.component.ts",
+      "filePath": "/projects/errors/documentation/code-examples/error/modal/error-demo.component.ts",
+      "rawContents": "import {\n  Component\n} from '@angular/core';\n\nimport {\n  ErrorModalConfig,\n  SkyErrorModalService\n} from '@skyux/errors';\n\n@Component({\n  selector: 'app-error-demo',\n  templateUrl: './error-demo.component.html',\n  providers: [SkyErrorModalService]\n})\nexport class ErrorDemoComponent {\n\n  constructor(\n    private errorService: SkyErrorModalService\n  ) { }\n\n  public openErrorModal(): void {\n    const config: ErrorModalConfig = {\n      errorTitle: 'Something went wrong.',\n      errorDescription: 'Close the modal, and come back later.',\n      errorCloseText: 'Close'\n    };\n    this.errorService.open(config);\n  }\n\n}\n"
+    },
+    {
+      "fileName": "error-demo.module.ts",
+      "filePath": "/projects/errors/documentation/code-examples/error/modal/error-demo.module.ts",
+      "rawContents": "import {\n  NgModule\n} from '@angular/core';\n\nimport {\n  CommonModule\n} from '@angular/common';\n\nimport {\n  SkyErrorModule\n} from '@skyux/errors';\n\nimport {\n  ErrorDemoComponent\n} from './error-demo.component';\n\n@NgModule({\n  imports: [\n    CommonModule,\n    SkyErrorModule\n  ],\n  declarations: [\n    ErrorDemoComponent\n  ],\n  exports: [\n    ErrorDemoComponent\n  ]\n})\nexport class ErrorDemoModule { }\n"
+    }
+  ]
+}