Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/renie/slideshowplugin

Simple Slideshow plugin using jQuery
https://github.com/renie/slideshowplugin

Last synced: about 2 months ago
JSON representation

Simple Slideshow plugin using jQuery

Awesome Lists containing this project

README 

        
Copyright (C) 2011  Renie Siqueira da Silva



This program is free software: you can redistribute it and/or modify

it under the terms of the GNU Affero General Public License as

published by the Free Software Foundation, either version 3 of the

License, or (at your option) any later version.



This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU Affero General Public License for more details.



You should have received a copy of the GNU Affero General Public License

along with this program.  If not, see .



/------------------------------------------------------/



Copyright (C) 2011  Renie Siqueira da Silva



Este programa é software livre: você pode distribui-lo e/ou modifica-lo

sob os termos da GNU Affero General Public License como 

publicado pela Free Software Foundation,  ou da versão 3 da

licensa, ou (a seu critério) qualquer versão anterior.



Este programa é distribuído na esperança de que possa ser útil,

mas SEM QUALQUER GARANTIA; 

but WITHOUT ANY WARRANTY; sem mesmo a garantia implícita de

COMERCIALIZAÇÃO ou ADEQUAÇÃO PARA FIM PARTICULAR. Veja a

GNU Affero General Public para mais detalhes.



Você deve ter recebido uma cópia da GNU Affero General Public License

junto com este programa.  Se não, veja .



/------------------------------------------------------/



PS. The copy of the GNU Affero General Public License is on AGPL.txt



OBS. A cópia da GNU Affero General Public License está no AGPL.txt 

(somente em inglês, traduções da AGPL não são oficiais)



/------------------------------------------------------/

/------------------------------------------------------/



/------------------------------------------------------/

USE INSTRUCTIONS



Create an unordered list e put one image in each item list.

This unordered list must be wrapped by some "block element" (preferably a DIV element)

On javascript, call the slideshow function to that wrapper. Like this:



$('#idMyDiv').slideshow();



The following parameters are allowed:



itemWidth

itemHeight

widthSlider

transitionSpeed

pauseTime

effect( 2 options for now: horizontalSlide and fade )

*UPDATE 

	navBar (true or false)

*UPDATE2

	navigationGapItem

	navigationItemFontSize

	navigationItemFontFamily

	navigationItemFontWeight

	navigationItemHeight

	navigationItemWidth

	navigationItemBorderSize

	navigationItemBorderStyle

	navigationItemBorderColor

	navigationItemBorderRadius

	navigationItemBackgroundColor

	navigationItemTextColor

	navigationHoverItemBorderColor

	navigationHoverItemBackgroundColor

	navigationHoverItemTextColor



--Warnings--



NO CSS IS REQUIRED

JQUERY IS REQUIRED

IT WASN'T TESTED ON INTERNET EXPLORER ( and probably won't be )



--Plugin Patterns--

If you won't pass any param to plugin, it'll use default ones. This is the pattern:



itemWidth: [width of your image]

itemHeight: [height of your images]

widthSlider: [width of your images multiplied by number of images]

transitionSpeed: 1500

pauseTime: 3000

effect: 'fade'

navigation: true

navigationGapItem: '5px'

navigationItemFontSize: '16px'

navigationItemFontFamily: 'Helvetica'

navigationItemFontWeight: 'bold'

navigationItemHeight: '30px'

navigationItemWidth: '30px'

navigationItemBorderSize: '1px'

navigationItemBorderStyle: 'solid'

navigationItemBorderColor: '#666'

navigationItemBorderRadius: '5px'

navigationItemBackgroundColor: '#fff'

navigationItemTextColor: '#000'

navigationHoverItemBorderColor: '#dedede'

navigationHoverItemBackgroundColor: '#666'

navigationHoverItemTextColor: '#dedede'



/------------------------------------------------------/

INSTRUÇÕES DE USO



Crie uma lista não ordenada e coloco uma imagem em cada item desta lista.

Essa lista precisa estar dentro de um elemente do tipo 'block(preferencialmente uma DIV)

No javascript, chame a função slideshow no elemento q envolve a lista. Desta forma:



$('#idMyDiv').slideshow();



Os seguintes parâmetros são permitidos:



itemWidth

itemHeight

widthSlider

transitionSpeed

pauseTime

effect( 2 opções por enquanto: horizontalSlide e fade )

*ATUALIZAÇÃO 

	navBar (true ou false)

*ATUALIZAÇÃO2

	navigationGapItem

	navigationItemFontSize

	navigationItemFontFamily

	navigationItemFontWeight

	navigationItemHeight

	navigationItemWidth

	navigationItemBorderSize

	navigationItemBorderStyle

	navigationItemBorderColor

	navigationItemBorderRadius

	navigationItemBackgroundColor

	navigationItemTextColor

	navigationHoverItemBorderColor

	navigationHoverItemBackgroundColor

	navigationHoverItemTextColor



--Avisos--



NENHUM CSS É NECESSÁRIO

JQUERY É NECESSÁRIO

NÃO FOI TESTADO NO INTERNET EXPLORER( e provavelmente não será )



--Padrões do Plugin--

Se você não passar parâmetros para o plugin, ele usará valores padrão. Este é o padrão:



itemWidth: [largura das suas imagens]

itemHeight: [altura das suas imagens]

widthSlider: [largura das suas imagens multiplicado pelo número de imagens]

transitionSpeed: 1500

pauseTime: 3000

effect: 'fade'

navigation: true

navigationGapItem: '5px'

navigationItemFontSize: '16px'

navigationItemFontFamily: 'Helvetica'

navigationItemFontWeight: 'bold'

navigationItemHeight: '30px'

navigationItemWidth: '30px'

navigationItemBorderSize: '1px'

navigationItemBorderStyle: 'solid'

navigationItemBorderColor: '#666'

navigationItemBorderRadius: '5px'

navigationItemBackgroundColor: '#fff'

navigationItemTextColor: '#000'

navigationHoverItemBorderColor: '#dedede'

navigationHoverItemBackgroundColor: '#666'

navigationHoverItemTextColor: '#dedede'