jQuery Modal Window Dokumentation

API

jQuery Modal Window controller

Public variable

• mwc.settings
  De settings, som ligger til grund for jQuery Modal Window. Det er endnu ikke muligt at ændre settings on the fly.
• mwc.modal
  Selve modal vinduet, som jQuery objekt
• mwc.modalContent
  Modal vinduets indhold. Altså det indhold du vælger skal vises.
• mwc.background
  Baggrunden bag modal vinduet. Madpapiret kaldes det også ofte.
• mwc.block
  jQuery Modal Window containeren, som indeholder både modal og background

Public metoder

• mwc.fireResizeModal(modalCss, ignoreStartEvent, noAnimate)
  Denne metode starter en gencalculering og placering af modal vinduet.
  modalCss giver mulighed for at sende egne mål med på vinduets størrelse og placering. ignoreStartEvent vil tvinge jQuery Modal Window til IKKE at fyre onModalResize eventen, hvis den sættes til true. noAnimate vil ignorere en eventuel animation når modal vinduet ændrer størrelse.
• mwc.calculateModalCSS()
  Denne metode udregner den plads og position modal vinduet vil kunne optage. Kan benyttes til at få nøjagtige mål på hvor stort ens indhold må være.
  returnerer en modalCss.
• mwc.deconstruct()
  Lukker og fjerner jQuery Modal Window.
• mwc.getScrollBarWidth()
  Returnerer størrelsen på browserens scrollbar bredde. Kan være nyttig info, hvis man har tænkt sig at lave scroll.

jQuery Modal Window plugin API

• jQuery.fn.openModalWindow(settings)
  Denne metode åbner et bestemt indhold i et nyt jQuery Modal Window. Intet nyt under solen her.
• jQuery.fn.closeModalWindow()
  Kaldes denne metode på et hvilket som helst element inde i jQuery Modal Window’s block element vil den lukke og fjerne sig selv.
• jQuery.fn.updateModalWindow(modalCss, ignoreStartEvent)
  Kaldes denne metode på et hvilket som helst element inde i jQuery Modal Window’s block element vil den udregne en ny størrelse og position.
• jQuery.fn.getModalWindowControl()
  Denne metode er ny og kaldes den på et hvilket som helst element inde i jQuery Modal Window’s block element vil den returnere jQuery Modal Window controlleren, hvis API man så kan benytte.

Indstillinger

onOpen

onOpen eventen, som fyres så snart man åbner et jQuery Modal Window
type: function
Værdi: function (content) { }

onOpened

onOpened eventen, som fyres så snart pluginet er færdigt med at åbne et jQuery Modal Window
type: function
Værdi: function (content) { }

onClose

onClose eventen, som fyres så snart man lukker et jQuery Modal Window
type: function
Værdi: function (content) { }

onClosed

onClosed eventen, som fyres så snart pluginet er færdigt med at lukke et jQuery Modal Window
type: function
Værdi: function (content) { }

backgroundOpacity

Gennemsigtigheden af den baggrund, som ligger bagved jQuery Modal Window.
type: float
Værdi: 0.8

backgroundBackground

Baggrundsfarven eller billedet på på baggrunden.
type: css background værdi
Værdi: ‘#000′

minDistanceToViewport

Den margin, der skal være fra jQuery Modal Window ud til kanten af browservinduet.
type: integer
Værdi: 0

zIndex

Den z-index position jQuery Modal Window skal placeres i.
type: integer
Værdi: 999

animateTime

Tiden i milisekunder det skal tage for jQuery Modal Window at animere sig frem.
type: integer
Værdi: 500

closeOnBlockClick

Boolsk værdi, som angiver om jQuery Modal Window skal lukke når der klikkes på baggrunden.
type: boolean
Værdi: true

fixedTop

Den absolutte placering af jQuery Modal Window fra browservinduets top.
type: integer (null hvis ingen værdi ønskes)
Værdi: null

fixedLeft

Den absolutte placering af jQuery Modal Window fra browservinduets venstre side.
type: integer (null hvis ingen værdi ønskes)
Værdi: null

jQuery Modal Window Demoer

Se demoer og prøv med dine egne indstillinger.