https://github.com/trychlos/pwix-image-includer
A Blaze component which provides a dynamic image includer
https://github.com/trychlos/pwix-image-includer
Last synced: about 1 year ago
JSON representation
A Blaze component which provides a dynamic image includer
- Host: GitHub
- URL: https://github.com/trychlos/pwix-image-includer
- Owner: trychlos
- Created: 2024-10-21T12:57:26.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-19T15:13:00.000Z (over 1 year ago)
- Last Synced: 2025-02-05T23:40:02.860Z (over 1 year ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
Awesome Lists containing this project
README
# pwix:image-includer
## What is it
A simple Blaze component for Meteor which provides a dynamic image includer.
## Usage
Very simple:
### Include in your HTML template
```
{{> ImageIncluder }}
```
## Configuration
None at the moment.
## Provides
### Functions
#### `ImageIncluder.configure( o )`
See [below](#configuration)
##### `ImageIncluder.i18n.namespace()`
Returns the i18n namespace used by the package. Used to add translations at runtime.
Available both on the client and the server.
### Blaze components
#### `ImageIncluder`
A simple image includer.
The component is configurable with an object passed as an argument, which may contain:
- `classes`:
The classes to set on the `img` element.
Defaults to none.
- `title`:
A title to set on the `img` element.
Defaults to none.
- `imageUrl`:
The url of the image to be displayed.
Defaults to none.
- `defaultIcon`:
The name of the Font Awesome default svg, defaulting to 'fa-font-awesome'.
- `imageWidth`:
An optional width, defaulting to '10em'.
- `imageHeight`:
An optional height, defaulting to '11.5em'
- `withInput`:
Whether have an input field, defaulting to 'false'.
## NPM peer dependencies
This package has no NPM dependencies.
## Translations
New and updated translations are willingly accepted, and more than welcome. Just be kind enough to submit a PR on the [Github repository](https://github.com/trychlos/pwix-image-includer/pulls).
## Cookies and comparable technologies
None at the moment.
## Issues & help
In case of support or error, please report your issue request to our [Issues tracker](https://github.com/trychlos/pwix-image-includer/issues).
---
P. Wieser
- Last updated on 2024, Nov. 19th