Giter VIP home page Giter VIP logo

cliche's Introduction

Cliche

A media manager for MODx Revolution

Installation instructions:

  • Install the component via the package manager.
  • Reload the page
  • Click on Cliche menu item under components
  • Create an album using the dedicated button
  • Browse your album by clicking the newly created elements

You can go back and forth in your albums by using the breadcrumbs.

Front End Snippets

There are 3 snippets available, they all share the same properties.

Snippets Usage

Simply drop the snippet call anywhere in your document.

[[Cliche]]

The 2 other snippets requires an id to work

Retreiving an album sets

[[ClicheAlbum? 
    &id=`your_album_id`
]]

Retreiving a single item

[[ClicheImage? 
    &id=`your_item_id`
]]

Available Parameters

List of the available parameters (and their default values) :

  • thumbWidth (120),
  • thumbHeight (120),
  • itemTpl (item),
  • albumsWrapperTpl (albumwrapper),
  • albumItemTpl (albumitem),
  • display (default),
  • idParam (cid),
  • loadCSS (true),
  • css (default),
  • config (null),
  • columns (3),
  • columnBreak (<\br style="clear: both;">),
  • idParam (cid), //Only used by the main cliche snippet
  • viewParam (view), //Only used by the main cliche snippet
  • viewParamName (item or set) //Only used by the main cliche snippet

Per default, all galleries are displayed a la Wordpress. Example for tree columns:

[container] [item][item][item][linebreak] [item][item][item][linebreak] [item][item][item][linebreak] [/container]

However if you want to use a unordered list of item, you would want to not generate the linebreak. In that case, just set the columns parameter to 0 :

[[ClicheImage? 
    &columns=`0`
]]

For testing purpose, Cliche comes with a Gallerific example plugin. To use it, set you snippet call like the following :

[[!ClicheAlbum?
	&id=`your_album_id`
	&thumbWidth=`75` //Or any width
	&thumbHeight=`75` //Or any height
	&display=`galleriffic` //Required
	&config=`config` //Required
	&css=`style` //Required
	&columns=`0` //Required
]]

Notes

All chunks are filebased located in the assets chunks directory

The gallerific plugin does not bundle jquery, therefore, you will need to load it in other way in your page.

This is an incomplete "getting started" base documetnation for beta testers The complete documentation is under writing.

Thanks for using Cliche.

cliche's People

Contributors

lossendae avatar hansek avatar

Stargazers

Aleksander avatar

Watchers

Aleksander avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.