You are here

README.txt in NG Lightbox 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 2.x README.txt
## Setup

Go to example.com/admin/config/media/ng-lightbox and configure the paths you would
like to be auto-lightboxed.

Any page that runs through theme_link() and has either the internal path or alias listed at
/admin/config/media/ng-lightbox will automatically be lightboxed. If you want to manually apply the lightbox to a link,
simply add the "ng-lightbox" class to the anchor.

## Client Side Integration

There maybe times when you can not add the ng-lightbox class to the element server side, such as within a map. You can
setup an NG Lightbox client side like so:

    NGLightbox.initElement(element, path);

Note, the path parameter provides the URL to load into the lightbox. If element is an anchor then the path will be read
from the href attribute if not provided.

## Rebuilding SASS

If you're contributing to ng_lightbox you can re-generate the css with the
following command from within the ng_lightbox folder.

    compass compile --no-sourcemap --no-debug-info --force -e production sass/lightbox.scss

If you're simply using the ng_lightbox module and want to have your own theme you can copy the
sass file into your theme and begin customising from there.

File

README.txt
View source
  1. ## Setup
  2. Go to example.com/admin/config/media/ng-lightbox and configure the paths you would
  3. like to be auto-lightboxed.
  4. Any page that runs through theme_link() and has either the internal path or alias listed at
  5. /admin/config/media/ng-lightbox will automatically be lightboxed. If you want to manually apply the lightbox to a link,
  6. simply add the "ng-lightbox" class to the anchor.
  7. ## Client Side Integration
  8. There maybe times when you can not add the ng-lightbox class to the element server side, such as within a map. You can
  9. setup an NG Lightbox client side like so:
  10. NGLightbox.initElement(element, path);
  11. Note, the path parameter provides the URL to load into the lightbox. If element is an anchor then the path will be read
  12. from the href attribute if not provided.
  13. ## Rebuilding SASS
  14. If you're contributing to ng_lightbox you can re-generate the css with the
  15. following command from within the ng_lightbox folder.
  16. compass compile --no-sourcemap --no-debug-info --force -e production sass/lightbox.scss
  17. If you're simply using the ng_lightbox module and want to have your own theme you can copy the
  18. sass file into your theme and begin customising from there.