{"id":15618019,"url":"https://github.com/omnedia/ngx-flickering-grid","last_synced_at":"2025-07-30T07:33:55.129Z","repository":{"id":254867036,"uuid":"847761347","full_name":"omnedia/ngx-flickering-grid","owner":"omnedia","description":"A simple component library to create a container with an animated grid pattern background. ","archived":false,"fork":false,"pushed_at":"2025-02-18T09:59:04.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-15T02:44:31.515Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/omnedia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-26T13:52:28.000Z","updated_at":"2025-02-18T09:58:22.000Z","dependencies_parsed_at":"2024-08-26T20:15:45.751Z","dependency_job_id":null,"html_url":"https://github.com/omnedia/ngx-flickering-grid","commit_stats":null,"previous_names":["omnedia/ngx-flickering-grid"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnedia%2Fngx-flickering-grid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnedia%2Fngx-flickering-grid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnedia%2Fngx-flickering-grid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omnedia%2Fngx-flickering-grid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omnedia","download_url":"https://codeload.github.com/omnedia/ngx-flickering-grid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997087,"owners_count":21195797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T08:00:54.316Z","updated_at":"2025-04-15T02:44:37.329Z","avatar_url":"https://github.com/omnedia.png","language":"TypeScript","funding_links":[],"categories":["Recently Updated","Third Party Components"],"sub_categories":["[Oct 01, 2024](/content/2024/10/01/README.md)","Layout"],"readme":"# ngx-flickering-grid\n\n\u003ca href=\"https://ngxui.com\" target=\"_blank\" style=\"display: flex;gap: .5rem;align-items: center;cursor: pointer; padding: 0 0 0 0; height: fit-content;\"\u003e\n  \u003cimg src=\"https://ngxui.com/assets/img/ngxui-logo.png\" style=\"width: 64px;height: 64px;\"\u003e\n\u003c/a\u003e\n\nThis Library is part of the NGXUI ecosystem. \u003cbr\u003e\nView all available components at https://ngxui.com\n\n`@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.\n\n## Features\n\n- Dynamic flickering grid effect rendered on an HTML5 canvas.\n- Customizable grid parameters, including square size, grid gap, flicker chance, and maximum opacity.\n- Easy to integrate as a standalone component with optional viewport-based animation triggering.\n\n## Installation\n\nInstall the library using npm:\n\n```bash\nnpm install @omnedia/ngx-flickering-grid\n```\n\n## Usage\n\nImport the `NgxFlickeringGridComponent` in your Angular module or component:\n\n```typescript\nimport {NgxFlickeringGridComponent} from '@omnedia/ngx-flickering-grid';\n\n@Component({\n  ...\n    imports:\n[\n  ...\n    NgxFlickeringGridComponent,\n],\n...\n})\n```\n\nUse the component in your template:\n\n```html\n\n\u003com-flickering-grid\n  [squareSize]=\"6\"\n  [gridGap]=\"8\"\n  [flickerChance]=\"0.5\"\n  [color]=\"'#ffcc00'\"\n  [maxOpacity]=\"0.4\"\n  styleClass=\"custom-flickering-grid\"\n\u003e\n  \u003ch1\u003eYour Content Here\u003c/h1\u003e\n\u003c/om-flickering-grid\u003e\n```\n\n## How It Works\n\n- Dynamic Flickering Grid: The grid's squares will flicker at random intervals, controlled by the flickerChance input. You can adjust the size, gap, and opacity of the squares for different visual effects.\n- Viewport Animation: The grid animation is only triggered when the component enters the viewport, enhancing performance by preventing unnecessary rendering.\n- Global and Custom Styling: You can style the .om-flickering-grid container globally or apply custom styles using the styleClass input.\n\n## API\n\n```html\n\n\u003com-flickering-grid\n  [squareSize]=\"squareSize\"\n  [gridGap]=\"gridGap\"\n  [flickerChance]=\"flickerChance\"\n  [color]=\"color\"\n  [maxOpacity]=\"maxOpacity\"\n  styleClass=\"your-custom-class\"\n\u003e\n  \u003cng-content\u003e\u003c/ng-content\u003e\n\u003c/om-flickering-grid\u003e\n```\n\n- `squareSize` (optional): Size of each square in pixels. Defaults to 4px.\n- `gridGap` (optional): Gap between the squares in pixels. Defaults to 6px.\n- `flickerChance` (optional): Probability of squares flickering, represented as a value between 0 and 1. Defaults to 0.3.\n- `color` (optional): The color of the grid squares. Accepts any valid CSS color value. Defaults to '#6B7280'.\n- `maxOpacity` (optional): Maximum opacity level of the squares. Accepts a value between 0 and 1. Defaults to 0.3.\n- `styleClass` (optional): Custom CSS class to apply to the .om-flickering-grid container.\n\n## Example\n\n```html\n\n\u003com-flickering-grid [squareSize]=\"8\" [gridGap]=\"10\" [flickerChance]=\"0.4\" [color]=\"'#3498db'\" [maxOpacity]=\"0.5\"\u003e\n  \u003cdiv class=\"content\"\u003e\n    \u003cp\u003eFlickering Grid Background Content\u003c/p\u003e\n  \u003c/div\u003e\n\u003c/om-flickering-grid\u003e\n```\n\nThis will create a flickering grid with larger squares, more pronounced gaps, and a blue color, while the content inside remains unaffected by the animation.\n\n## Contributing\n\nContributions are welcome. Please submit a pull request or open an issue to discuss your ideas.\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnedia%2Fngx-flickering-grid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomnedia%2Fngx-flickering-grid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnedia%2Fngx-flickering-grid/lists"}