Skip to content

Commit e5ccf31

Browse files
MKirovaMKirova
authored andcommitted
chore(*): Mark splitter bar as hidden from API.
1 parent 3cc32a1 commit e5ccf31

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

projects/igniteui-angular/src/lib/splitter/splitter-bar/splitter-bar.component.ts

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@ import { IDragMoveEventArgs, IDragStartEventArgs, DragDirection } from '../../di
77
export const SPLITTER_INTERACTION_KEYS = new Set('right down left up arrowright arrowdown arrowleft arrowup'.split(' '));
88

99
/**
10-
* Provides reference to `SplitBarComponent` component.
11-
* Represents the draggable gripper that visually separates panes and allows for changing their sizes.
12-
* @export
13-
* @class SplitBarComponent
10+
* @hidden @internal
11+
* Represents the draggable bar that visually separates panes and allows for changing their sizes.
1412
*/
1513
@Component({
1614
selector: 'igx-splitter-bar',
@@ -66,27 +64,18 @@ export class IgxSplitBarComponent {
6664

6765
/**
6866
* An event that is emitted whenever we start dragging the current `SplitBarComponent`.
69-
* @memberof SplitBarComponent
7067
*/
7168
@Output()
7269
public moveStart = new EventEmitter<IgxSplitterPaneComponent>();
7370

7471
/**
7572
* An event that is emitted while we are dragging the current `SplitBarComponent`.
76-
* @memberof SplitBarComponent
7773
*/
7874
@Output()
7975
public moving = new EventEmitter<number>();
8076

81-
/**
82-
* An event that is emitted when collapsing the pane
83-
*/
84-
@Output()
85-
public togglePane = new EventEmitter<IgxSplitterPaneComponent>();
8677
/**
8778
* A temporary holder for the pointer coordinates.
88-
* @private
89-
* @memberof SplitBarComponent
9079
*/
9180
private startPoint!: number;
9281

@@ -184,6 +173,9 @@ export class IgxSplitBarComponent {
184173
return this.siblings[1].collapsed && !this.siblings[0].collapsed;
185174
}
186175

176+
/**
177+
* @hidden @internal
178+
*/
187179
public onDragStart(event: IDragStartEventArgs) {
188180
if (this.resizeDisallowed) {
189181
event.cancel = true;
@@ -193,6 +185,9 @@ export class IgxSplitBarComponent {
193185
this.moveStart.emit(this.pane);
194186
}
195187

188+
/**
189+
* @hidden @internal
190+
*/
196191
public onDragMove(event: IDragMoveEventArgs) {
197192
const isHorizontal = this.type === SplitterType.Horizontal;
198193
const curr = isHorizontal ? event.pageX : event.pageY;
@@ -209,6 +204,9 @@ export class IgxSplitBarComponent {
209204
return !!relatedTabs.find(x => x.resizable === false);
210205
}
211206

207+
/**
208+
* @hidden @internal
209+
*/
212210
public onCollapsing(next: boolean) {
213211
const prevSibling = this.siblings[0];
214212
const nextSibling = this.siblings[1];

0 commit comments

Comments
 (0)