Skip to content

Commit b56d51e

Browse files
committed
Updated ReadMe to add relation to ngxui.com
1 parent 0ef83bd commit b56d51e

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# ngx-flickering-grid
22

3+
<a href="https://ngxui.com" target="_blank" style="display: flex;gap: .5rem;align-items: center;cursor: pointer; padding: 0 0 0 0; height: fit-content;">
4+
<img src="https://ngxui.com/assets/img/ngxui-logo.png" style="width: 64px;height: 64px;">
5+
<p style="font-weight: bold; padding: 0; margin: 0; font-size: 4rem">NGXUI</p>
6+
</a>
7+
8+
This Library is part of the NGXUI ecosystem. <br>
9+
View all available components at https://ngxui.com
10+
311
`@omnedia/ngx-flickering-grid` is an Angular library that renders a dynamic flickering grid background with customizable square size, grid gaps, flicker behavior, and color. This component is perfect for adding a unique animated grid effect behind content in your Angular application.
412

513
## Features
@@ -21,21 +29,23 @@ npm install @omnedia/ngx-flickering-grid
2129
Import the `NgxFlickeringGridComponent` in your Angular module or component:
2230

2331
```typescript
24-
import { NgxFlickeringGridComponent } from '@omnedia/ngx-flickering-grid';
32+
import {NgxFlickeringGridComponent} from '@omnedia/ngx-flickering-grid';
2533

2634
@Component({
2735
...
28-
imports: [
29-
...
30-
NgxFlickeringGridComponent,
31-
],
36+
imports:
37+
[
3238
...
39+
NgxFlickeringGridComponent,
40+
],
41+
...
3342
})
3443
```
3544

3645
Use the component in your template:
3746

3847
```html
48+
3949
<om-flickering-grid
4050
[squareSize]="6"
4151
[gridGap]="8"
@@ -57,6 +67,7 @@ Use the component in your template:
5767
## API
5868

5969
```html
70+
6071
<om-flickering-grid
6172
[squareSize]="squareSize"
6273
[gridGap]="gridGap"
@@ -79,6 +90,7 @@ Use the component in your template:
7990
## Example
8091

8192
```html
93+
8294
<om-flickering-grid [squareSize]="8" [gridGap]="10" [flickerChance]="0.4" [color]="'#3498db'" [maxOpacity]="0.5">
8395
<div class="content">
8496
<p>Flickering Grid Background Content</p>
@@ -94,4 +106,4 @@ Contributions are welcome. Please submit a pull request or open an issue to disc
94106

95107
## License
96108

97-
This project is licensed under the MIT License.
109+
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)