Skip to content

Commit ce819a7

Browse files
committed
feat: Api ref documantation added to the repo
1 parent c88bac3 commit ce819a7

File tree

996 files changed

+224968
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

996 files changed

+224968
-2
lines changed

packages/igniteui-mcp/.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ yarn-debug.log*
3232
yarn-error.log*
3333

3434
# API MCP - Generated documentation
35-
igniteui-doc-mcp/docs/angular
36-
igniteui-doc-mcp/docs/webcomponents
35+
# igniteui-doc-mcp/docs/angular
36+
# igniteui-doc-mcp/docs/webcomponents
3737

3838
tmp/

packages/igniteui-mcp/igniteui-doc-mcp/docs/angular/api/README.md

Lines changed: 918 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Class: AbsoluteScrollStrategy
2+
3+
Defined in: [angular/igniteui-angular/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts:8](https://github.com/IgniteUI/igniteui-angular/blob/28ea802da6e8bd841b82e336a16781159d69e779/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts#L8)
4+
5+
On scroll reposition the overlay content.
6+
7+
## Extends
8+
9+
- [`ScrollStrategy`](ScrollStrategy.md)
10+
11+
## Constructors
12+
13+
### Constructor
14+
15+
> **new AbsoluteScrollStrategy**(`scrollContainer?`): `AbsoluteScrollStrategy`
16+
17+
Defined in: [angular/igniteui-angular/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts:16](https://github.com/IgniteUI/igniteui-angular/blob/28ea802da6e8bd841b82e336a16781159d69e779/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts#L16)
18+
19+
#### Parameters
20+
21+
##### scrollContainer?
22+
23+
`HTMLElement`
24+
25+
#### Returns
26+
27+
`AbsoluteScrollStrategy`
28+
29+
#### Overrides
30+
31+
[`ScrollStrategy`](ScrollStrategy.md).[`constructor`](ScrollStrategy.md#constructor)
32+
33+
## Methods
34+
35+
### attach()
36+
37+
> **attach**(): `void`
38+
39+
Defined in: [angular/igniteui-angular/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts:48](https://github.com/IgniteUI/igniteui-angular/blob/28ea802da6e8bd841b82e336a16781159d69e779/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts#L48)
40+
41+
Attaches the strategy
42+
```typescript
43+
settings.scrollStrategy.attach();
44+
```
45+
46+
#### Returns
47+
48+
`void`
49+
50+
#### Overrides
51+
52+
[`ScrollStrategy`](ScrollStrategy.md).[`attach`](ScrollStrategy.md#attach)
53+
54+
***
55+
56+
### detach()
57+
58+
> **detach**(): `void`
59+
60+
Defined in: [angular/igniteui-angular/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts:64](https://github.com/IgniteUI/igniteui-angular/blob/28ea802da6e8bd841b82e336a16781159d69e779/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts#L64)
61+
62+
Detaches the strategy
63+
```typescript
64+
settings.scrollStrategy.detach();
65+
```
66+
67+
#### Returns
68+
69+
`void`
70+
71+
#### Overrides
72+
73+
[`ScrollStrategy`](ScrollStrategy.md).[`detach`](ScrollStrategy.md#detach)
74+
75+
***
76+
77+
### initialize()
78+
79+
> **initialize**(`document`, `overlayService`, `id`): `void`
80+
81+
Defined in: [angular/igniteui-angular/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts:31](https://github.com/IgniteUI/igniteui-angular/blob/28ea802da6e8bd841b82e336a16781159d69e779/projects/igniteui-angular/core/src/services/overlay/scroll/absolute-scroll-strategy.ts#L31)
82+
83+
Initializes the strategy. Should be called once
84+
85+
#### Parameters
86+
87+
##### document
88+
89+
`Document`
90+
91+
reference to Document object.
92+
93+
##### overlayService
94+
95+
[`IgxOverlayService`](IgxOverlayService.md)
96+
97+
IgxOverlay service to use in this strategy.
98+
99+
##### id
100+
101+
`string`
102+
103+
Unique id for this strategy.
104+
```typescript
105+
settings.scrollStrategy.initialize(document, overlay, id);
106+
```
107+
108+
#### Returns
109+
110+
`void`
111+
112+
#### Overrides
113+
114+
[`ScrollStrategy`](ScrollStrategy.md).[`initialize`](ScrollStrategy.md#initialize)

0 commit comments

Comments
 (0)