@goodgamestudios/cxf-dialog

CXF plugin for dialog managing

Usage no npm install needed!

<script type="module">
  import goodgamestudiosCxfDialog from 'https://cdn.skypack.dev/@goodgamestudios/cxf-dialog';
</script>

README

API to control dialogs and popups

Dialogs

  • cxf.emit('cxf.dialog.open', url: string) - creates a dialog
  • cxf.emit('cxf.dialog.close', url: string) - removes a dialog

Popups

  • cxf.emit('cxf.popup.open', {id: string, url: string}) - creates a popup with specified id
  • cxf.emit('cxf.popup.close', {id: string}) - removes a popup with specified id

Close Dialog/Popup from inside

      window.parent.postMessage({
        name: `cxf.popup.close`,
        payload: {
          id: url.searchParams.get('elementId')
        },
      }, '*');

Popups vs Dialogs

You can create multiple popups at the same page by specifying id. Dialog can be only single.

CI/CD

  • qa branch publishes with @qa tag and appends a pre-release postfix. Example: 1.4.1-qa.1
  • master branch publishes with @latest tag. Example: 1.4.1

How to create a feature

  • branch from qa
  • make feature
  • stage changes
  • run npm run commit
  • push a new branch to the repo
  • create merge request (MR)
  • merge MR to qa branch

How to publish

  • merge qa to master