Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omnedia/ngx-lamp
A simple component library to create a lamp.
https://github.com/omnedia/ngx-lamp
Last synced: about 2 months ago
JSON representation
A simple component library to create a lamp.
- Host: GitHub
- URL: https://github.com/omnedia/ngx-lamp
- Owner: omnedia
- License: mit
- Created: 2024-08-25T21:27:48.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-08-25T22:37:27.000Z (5 months ago)
- Last Synced: 2024-10-03T08:06:02.300Z (4 months ago)
- Language: SCSS
- Size: 3.91 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - ngx-lamp (⭐0) - A simple component library to create a lamp. (Recently Updated / [Oct 01, 2024](/content/2024/10/01/README.md))
- awesome-angular - ngx-lamp - A simple component library to create a lamp. (Table of contents / Third Party Components)
- fucking-awesome-angular - ngx-lamp - A simple component library to create a lamp. (Table of contents / Third Party Components)
README
# ngx-lamp
`@omnedia/ngx-lamp` is an Angular library that provides a customizable lamp effect component. The component allows for flexible configuration of the lamp's color and background color, enabling you to create various glowing effects that can enhance the visual appeal of your Angular application.
## Features
- Customizable lamp color and background color.
- Lightweight and easy to integrate as a standalone component.
- Allows for full control over styles through custom CSS.
## Installation
Install the library using npm:
```bash
npm install @omnedia/ngx-lamp
```
## Usage
Import the `NgxLampComponent` in your Angular module or component:
```typescript
import { NgxLampComponent } from '@omnedia/ngx-lamp';
@Component({
...
imports: [
...
NgxLampComponent,
],
...
})
```
Use the component in your template:
```html
```
## How It Works
- Lamp and Background Color: The lampColor input controls the glowing color of the lamp, while the backgroundColor input allows you to set the background of the lamp effect. This provides flexibility to match the component to your application's theme.
- Global and Custom Styling: The .om-lamp container can be styled globally or with a custom styleClass. You can easily modify the appearance of the lamp using CSS variables.
## API
```html
```
- `lampColor` (optional): The color of the lamp's glow. Accepts any valid CSS color value (e.g., '#ffcc00', '#00ffcc').
- `backgroundColor` (optional): The background color behind the lamp. Accepts any valid CSS color value (e.g., '#1e1e1e', '#000000').
- `styleClass` (optional): A custom CSS class to apply to the .om-lamp container for additional styling.
## Example
```html
```
This will create a lamp effect with a tomato-colored glow and a black background.
## Styling
`.om-lamp`
- The main container for the lamp effect. You can apply global or custom styles using the styleClass input. The component uses CSS variables for easy control over the lamp's appearance.
- Make sure to give the `om-lamp` component a width and height of 100% to fit your wrapper size.
### Custom Lamp Styling Example
In this example, the lamp and its background are styled with custom colors via css instead of API values:
```html
```
```css
.lamp-wrapper {
width: 70%;
height: 700px;
}
om-lamp {
width: 100%;
height: 100%;
}
.custom-lamp {
--om-lamp-color: #ffcc00 !important;
--om-lamp-background-color: #1e1e1e !important;
}
```
This will apply a yellowish glow and a dark background to the lamp.
## Contributing
Contributions are welcome. Please submit a pull request or open an issue to discuss your ideas.
## License
This project is licensed under the MIT License.