+
+ SplitComponent (selector: 'as-split' / exportAs: 'asSplit')
+
+
+
+
+ Inputs |
+ Type |
+ Default |
+ Details |
+
+
+
+ @for (prop of splitDoc.inputs; track prop) {
+
+ {{ prop.name }} |
+ {{ prop.type }} |
+
+ {{ prop.default }}
+ |
+ |
+
+ }
+
+
+
+
+
+ Outputs |
+ Value |
+ Details |
+
+
+
+ @for (event of splitDoc.outputs; track event) {
+
+ {{ event.name }} |
+
+ {{ event.value }}
+ |
+ |
+
+ }
+
+
+
+
+
+ Access from TS class |
+ Type |
+ Details |
+
+
+
+ @for (item of splitDoc.class; track item) {
+
+ {{ item.name }} |
+
+ {{ item.type }}
+ |
+ |
+
+ }
+
+
+
+
+
+ SplitAreaComponent (selector: 'as-split-area' / exportAs: 'asSplitArea')
+
+
+
+
+ @Input() |
+ Type |
+ Default |
+ Details |
+
+
+
+ @for (prop of splitAreaDoc.inputs; track prop) {
+
+ {{ prop.name }} |
+ {{ prop.type }} |
+
+ {{ prop.default }}
+ |
+ |
+
+ }
+
+
+
+
+
+ SplitGutterDirective (selector: '[asSplitGutter] ')
+
+
Used as structural directive (*asSplitGutter
) to customize the gutter.
+
Mostly requires width: 100%
and height: 100%
in order to fill the whole gutter.
+
+ If the custom gutter is wider than the declared gutter size (using gutterSize
input) the areas will
+ overflow too. So attention is required to match the size of the gutter.
+
+
+
+
+ Template context property |
+ Type |
+ Details |
+
+
+
+ @for (prop of splitGutterDoc.templateContext; track prop) {
+
+ {{ prop.name }} |
+ {{ prop.type }} |
+ |
+
+ }
+
+
+
+
+
+ SplitGutterDragHandleDirective (selector: '[asSplitGutterDragHandle] ')
+
+
Used to declare an area inside asSplitGutter
to be a drag handle
+
Can be declared on multiple elements which means all of them are drag handles.
+
+
+
+ SplitGutterExcludeFromDragDirective (selector: '[asSplitGutterExcludeFromDrag] ')
+
+
Used to declare an area inside asSplitGutter
to be excluded from drag
+
Can be declared on multiple elements which means all of them are excluded from drag.
+
+ asSplitGutterExcludeFromDrag
inside asSplitGutterDragHandle
works as expected (all of the
+ element is a handle except the excluded area)
+
+
+ asSplitGutterDragHandle
inside asSplitGutterExcludeFromDrag
is ignored and the whole
+ element marked with exclude is excluded.
+
+
+
+
Theme
+
+
+
+ CSS variable |
+ Details |
+
+
+
+ @for (x of themeInfo; track x) {
+
+
+ --as-{{ x.name }}
+ |
+ |
+
+ }
+
+
+
+
CSS classes
+
+
+
+ Split element classes |
+ Details |
+
+
+
+ @for (x of cssClasses.split; track x) {
+
+
+ {{ x.name }}
+ |
+ |
+
+ }
+
+
+
+
+
+ Area element classes |
+ Details |
+
+
+
+ @for (x of cssClasses.area; track x) {
+
+
+ {{ x.name }}
+ |
+ |
+
+ }
+
+
+
+
+
+ Gutter element classes |
+ Details |
+
+
+
+ @for (x of cssClasses.gutter; track x) {
+
+
+ {{ x.name }}
+ |
+ |
+
+ }
+
+
+
diff --git a/src/app/documentation/documentation.component.ts b/src/app/documentation/documentation.component.ts
new file mode 100644
index 00000000..ec1d15e5
--- /dev/null
+++ b/src/app/documentation/documentation.component.ts
@@ -0,0 +1,265 @@
+import { Component } from '@angular/core'
+
+@Component({
+ selector: 'sp-doc',
+ styles: [
+ `
+ :host {
+ display: block;
+ width: 100%;
+ margin: 50px 0;
+ }
+ h4 {
+ margin: 20px 0;
+ }
+ .sel {
+ font-size: 16px;
+ color: #adadad;
+ }
+ tr > th {
+ color: #adadad;
+ }
+ tr > th:first-child,
+ .selContent {
+ font-weight: bold;
+ color: #ffc421;
+ }
+ tr > td:first-child {
+ font-weight: bold;
+ }
+ `,
+ ],
+ templateUrl: './documentation.component.html',
+
+})
+export class DocumentationComponent {
+ readonly splitDoc = {
+ inputs: [
+ {
+ name: 'dir',
+ type: 'SplitDir',
+ default: '"ltr"',
+ details:
+ 'Indicates the directionality of the areas: