Skip to content

Commit 7d6d4a4

Browse files
docs(README.md): update.
1 parent 7ee465a commit 7d6d4a4

File tree

1 file changed

+98
-1
lines changed

1 file changed

+98
-1
lines changed

README.md

Lines changed: 98 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Sass List - Modified list Sass module.
3333

3434
Extended sass modules:
3535

36-
* The [`sass:list`](https://sass-lang.com/documentation/modules/list/) is extended by [`@angular-package/sass-list`](https://docs.angular-package.dev/v/sass/list/overview) - module lets you access and modify values in lists.
36+
* The [`sass:list`](https://sass-lang.com/documentation/modules/list/) is extended by [`@angular-package/sass-list`](https://docs.angular-package.dev/v/sass/list/overview) - module makes it easy to combine, search, or split apart strings.
3737

3838
<br>
3939

@@ -48,6 +48,7 @@ Sass extension is **free** to use. If you enjoy it, please consider donating via
4848
* [Skeleton](#skeleton)
4949
* [Code scaffolding](#code-scaffolding)
5050
* [Documentation](#documentation)
51+
* [API](#api)
5152
* [Changelog](#changelog)
5253
* [Git](#git)
5354
* [Commit](#commit)
@@ -91,6 +92,102 @@ To get more help on the Angular CLI use `ng help` or go check out the [Angular C
9192

9293
The documentation is in construction and it's available at [https://docs.angular-package.dev/v/sass-list](https://docs.angular-package.dev/v/sass-list/)
9394

95+
### Api
96+
97+
#### list.get-[method]
98+
99+
#### list.get-bool()
100+
101+
```scss
102+
list.get-bool($list, $occurrence: first)
103+
```
104+
105+
#### list.get-list()
106+
107+
```scss
108+
list.get-list($list, $occurrence: first)
109+
```
110+
111+
#### list.get-map()
112+
113+
```scss
114+
list.get-map($list, $occurrence: first)
115+
```
116+
117+
#### list.get-number()
118+
119+
```scss
120+
list.get-number($list, $occurrence: first)
121+
```
122+
123+
#### list.get-string()
124+
125+
```scss
126+
list.get-string($list, $occurrence: first)
127+
```
128+
129+
#### list.get-type()
130+
131+
```scss
132+
list.get-type($list, $occurrence: any, $type, $types...)
133+
```
134+
135+
### list.remove-[method]
136+
137+
#### list.remove-duplicate()
138+
139+
```scss
140+
list.remove-duplicate($list, $values...)
141+
```
142+
143+
#### list.remove-list()
144+
145+
```scss
146+
list.remove-duplicate($list, $values...) // TODO
147+
```
148+
149+
#### list.remove-map()
150+
151+
```scss
152+
list.remove-map($list)
153+
```
154+
155+
#### list.remove-nth()
156+
157+
```scss
158+
list.remove-nth($list, $n, $nts...)
159+
```
160+
161+
#### list.remove-number()
162+
163+
```scss
164+
list.remove-number($list)
165+
```
166+
167+
#### list.remove-range()
168+
169+
```scss
170+
list.remove-range($list, $from: 1, $to: list.length($list)) // TODO
171+
```
172+
173+
#### list.remove-string()
174+
175+
```scss
176+
list.remove-string($list)
177+
```
178+
179+
#### list.remove-type()
180+
181+
```scss
182+
list.remove-type($list, $type, $types...)
183+
```
184+
185+
#### list.remove-value()
186+
187+
```scss
188+
list.remove-value($list, $value, $values...)
189+
```
190+
94191
<br>
95192

96193
## Changelog

0 commit comments

Comments
 (0)