sweetalert2/sweetalert2.github.io

Documentation for SweetAlert2

sweetalert2.github.io's Issues

An in-range update of babel7 is breaking the build 🚨

There have been updates to the babel7 monorepo:

• • The devDependency @babel/preset-env was updated from 7.5.2 to 7.5.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

This monorepo update includes releases of one or more dependencies which all belong to the babel7 group definition.

babel7 is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Document getIcon() and getIcons()

Swal.getIcon() was added in sweetalert2/sweetalert2#1443
Swal.getIcons() was implemented before but never documented

Add keydownListenerCapture documentation

The new param from https://github.com/sweetalert2/sweetalert2/releases/tag/v7.24.0

Improve timer example

As reported on sweetalert2/sweetalert2#1335 the OK button is shown for few milliseconds before it gets replaced by the loading icon. Move the implementation in this example to the onBeforeOpen.

Document Swal.getHeader()

Connected to sweetalert2/sweetalert2#1441

Document .getValidationMessage()

.getValidationMessage() has been added in sweetalert2/sweetalert2#1227

Version drop-down doesn't work on v7 page

#74 (comment):

@limonte Now the version drop-down doesn't work on the v7 page.. I suggest moving this code into the html files:

sweetalert2.github.io/src/app.js

Lines 761 to 770 in b7374b7

	$('#version').addEventListener('change', () => {
	switch ($('#version').value) {
	case '7.x':
	window.location.assign('v7.html')
	break
	default:
	window.location.assign('/')
	break
	}
	})

Idea: Pull documentation from other repos

The idea is to have the build process here pull markdown from each library repo, for the topics like #configuration and #methods which are duplicated here and (1) are updated more frequently and (2) don't have a use for js/dhtml .

This would eliminate the duplication of effort and fix a lot of the pain of the disadvantage i describe here - sweetalert2/sweetalert2#711 (comment)

We would probably want to split up our documentation into multiple .md files though.

Features and libraries for code samples

sweetalert2/sweetalert2#711 (comment)

Idea: It would be cool to use something like Codemirror for examples, but where you can execute/modify/execute the code. I absolutely <3 Semantic UI React's documentation site for this. https://react.semantic-ui.com/elements/button#button-example-labeled There are some other nifty features for the code samples there too.

All those nifty features would be nice-to-haves, but I think we really should have something that de-duplicates the code for viewing vs executing.

Anyone have a suggestion for a library to leverage for this?

Syntax highlighting for code samples is manual

Contributors have to insert html tags into the code samples manually for syntax highlighting. Some problems with this:

1. It's very tedious and time consuming to write code samples. Besides being a huge pain, this discourages including code samples with documentation updates.
2. Syntax highlighting is inconsistent. Very much so in some places.
3. It's difficult to read the JS in a plaintext view (e.g. code editor, github)

Part of #1

index.html & v7.html use the same js file

We have v7.html now as of 72a2787, but no src/app-v7.js. The v7.html uses the the same js as index.html (source: src/app.js, built: dist/bundle.js).

I assume we want to be able to update the examples for newer versions. We can't currently do that without breaking the v7 page (representation/displayed code would not match executed code)

For example, the RTL example on the v7 page is completely broken because, although the displayed code is valid for v7, the executed code is only valid for v8.

I might suggest reverting 72a2787 and reopening #68 until we get a working solution.

Updates from "Feature/object oriented" PR in core repo

Updates from "Feature/object oriented" PR in core repo sweetalert2/sweetalert2#1036

• Swal.fire method
• "How to" extend/subclass Swal

Document scrollbarPadding

Connected to sweetalert2/sweetalert2#1414

Get rid of jQuery

It's 2018 for heaven's sake.

Add docs for getCloseButton()

Connected to sweetalert2/sweetalert2#1177

Add docs for getFocusableElements()

Connected to sweetalert2/sweetalert2#1177

An in-range update of @sweetalert2/stylelint-config is breaking the build 🚨

The devDependency @sweetalert2/stylelint-config was updated from 1.1.0 to 1.1.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@sweetalert2/stylelint-config is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

---

Release Notes for v1.1.1

1.1.1 (2019-07-05)

Bug Fixes

• remove unused declaration-empty-line-before rule, add more tests (b0b2956)

Commits

The new version differs by 2 commits.

• 310910c chore(release): 1.1.1 [skip ci]
• b0b2956 fix: remove unused declaration-empty-line-before rule, add more tests

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Static site generator?

Anyone thought about using a static site generator for this?

It might help with a few things:

• Some (not all) content in Markdown (easier to write and review than html)
• Automatic generation of navigation component from definition of sections/pages
• Automatic generation of sitemap.xml from definition of sections/pages
• Automatically add "Edit this document" on each section/page, linking to that particular file on Github
• ...

It is kind of overwhelming how many options there are though... We can probably limit our options to those projects that are for Node.js.

Is this a good idea? If so, can anyone recommend a particular static site generator?

Add documentation for swal.mixin()

Mixins are probably the best recent feature in SweetAlert2, thanks, @zenflow 🍻

Related release: https://github.com/sweetalert2/sweetalert2/releases/tag/v7.16.0

---

There's the Methods section: https://sweetalert2.github.io/#methods but I feel like swal.mixin() is too awesome to be there.

@zenflow do you maybe have any idea how can we split the Methods section into several subsections?

Document available themes

• preview images
• how to install
• how to use

Google Chrome is showing mini-infobar above the CodeFund block

From https://developers.google.com/web/fundamentals/app-install-banners/

The mini-infobar is a Chrome UI component and is not controllable by the site.

An in-range update of webpack is breaking the build 🚨

The devDependency webpack was updated from 4.36.0 to 4.36.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes for v4.36.1

Bugfixes

• fix regression in 4.36.0 when using happypack

Commits

The new version differs by 3 commits.

• 92caa5d 4.36.1
• 4cac066 Merge pull request #9425 from webpack/bugfix/no-resolve-options
• 1f966eb fix #9424

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Add documentation for inputValue as a Promise

inputValue now could be a Promise (sweetalert2/sweetalert2#1025)

Related release: https://github.com/sweetalert2/sweetalert2/releases/tag/v7.17.0

@gverni said that he will submit the PR with the documentation

Document Swal.getContainer()

Document that width, padding, imageWidth, imageHeight can be in any CSS units

Connected to sweetalert2/sweetalert2#1510

Proposal for restructuring documentation page

I think that with all the new APIs and example, the documentation page is becoming quite long and heavy (and maybe confusing). Moreover I was thinking to add some more advanced usage examples, such as:

• sweetalert2/sweetalert2#1308
• sweetalert2/sweetalert2#1294 (I love this one BTW :-))

Plus maybe we can add some of the example coming from stackoverflow solutions.

If we all agree on adding these, then the documentation page may become very heavy, so we can break it into few pages, such as:

• Getting started and basic examples
• API and parameters documentation
• Advanced examples

Collaborators, what do you think? I can work on a proposal if you want to see it before approving.

View documentation for earlier versions?

I use sweetalert2 in projects quite regularly. There have been several occasions where version updates cause compatibility issues and I spend hours going through each of my projects to resolve them. I believe that in many cases it makes more sense for me to keep my existing version of sweetalert2 in place. I would do this, but that is challenging due to the fact that there is no longer documentation for me to reference for that particular version.

Am I missing this somewhere? Thanks!

Add l10n recipe

v7 -> v8

v8 has been released: https://github.com/sweetalert2/sweetalert2/releases/tag/v8.0.0

Make changes accordingly to new release

Document swal.params

Related issue sweetalert2/sweetalert2#1386

bundle.js file not updated for timer example

bundle.js file did not get updated with the changes in 6b29bbf. It still contains the non-DRY code and the backdrop set to false

Document customClass as an object, deprecate customContainerClass

Connected to sweetalert2/sweetalert2#1441

Deprecate customContainerClass and inputClass

Connected to sweetalert2/sweetalert2#1441

IE11 should be supported

By making the docs work in IE11 we will prevent users' confusions about supporting IE11 ( sweetalert2/sweetalert2#536)

Also, it's handy to quickly test docs page with IE11 and ensure everything works in it like in other browsers.

`build` script causes webpack error

If the build script is execute, this is the output:

No configuration file found and no output filename configured via CLI option.
A configuration file could be named 'webpack.config.js' in the current directory.
Use --help to display the CLI options.

Document extraParams

Connected to sweetalert2/sweetalert2#1084

extraParams was introduced in sweetalert2/sweetalert2@c71b4c9

It's passed as the second argument to

• preConfirm() https://github.com/sweetalert2/sweetalert2/blob/e9bfc82d5b0b8d7076e1922e770a9b478dc7ea41/src/instanceMethods/_main.js#L96
• inputValidator() https://github.com/sweetalert2/sweetalert2/blob/e9bfc82d5b0b8d7076e1922e770a9b478dc7ea41/src/instanceMethods/_main.js#L142

Move the "Timer functions example" to swetalert2-examples

The "Timer functions example" is too big IMO to be in https://sweetalert2.github.io

@gverni Do you agree to move it to sweetalert2-examples?

A grey line is overlapping with a header

Code samples are duplicated for viewing vs executing

This causes trouble for first-time contributors (example: #9 contributor had to go back and make another commit to make the same change to the same code in another place). I also find it annoying.

An in-range update of webpack is breaking the build 🚨

The devDependency webpack was updated from 4.35.3 to 4.36.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

webpack is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes for v4.36.0

Features

• SourceMapDevToolPlugin append option now supports the default placeholders in addition to [url]
• Arrays in resolve and parser options (Rule and Loader API) support backreferences with "..." when overriding options.

Commits

The new version differs by 42 commits.

• 95d21bb 4.36.0
• aa1216c Merge pull request #9422 from webpack/feature/dot-dot-dot-merge
• b3ec775 improve merging of resolve and parsing options
• 53a5ae2 Merge pull request #9419 from vankop/remove-valid-jsdoc-rule
• ab75240 Merge pull request #9413 from webpack/dependabot/npm_and_yarn/ajv-6.10.2
• 0bdabf4 Merge pull request #9418 from webpack/dependabot/npm_and_yarn/eslint-plugin-jsdoc-15.5.2
• f207cdc remove valid jsdoc rule in favour of eslint-plugin-jsdoc
• 31333a6 chore(deps-dev): bump eslint-plugin-jsdoc from 15.3.9 to 15.5.2
• 036adf0 Merge pull request #9417 from webpack/dependabot/npm_and_yarn/eslint-plugin-jest-22.8.0
• 37d4480 Merge pull request #9411 from webpack/dependabot/npm_and_yarn/simple-git-1.121.0
• ce2a183 chore(deps-dev): bump eslint-plugin-jest from 22.7.2 to 22.8.0
• 0beeb7e Merge pull request #9391 from vankop/create-hash-typescript
• bf1a24a #9391 resolve super call discussion
• bd7d95b #9391 resolve discussions, AbstractMethodError
• 4190638 chore(deps): bump ajv from 6.10.1 to 6.10.2

There are 42 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Add `heightAuto` documentation

Connected to sweetalert2/sweetalert2#1112

Add documentation and sample for new timer APIs

Add documentation and sample code for API introduced by:

sweetalert2/sweetalert2#1325
sweetalert2/sweetalert2#1322

Improve docs about inputValidator and preConfirm

Explicitly state that inputValidator and preConfirm can be either synchronous (return a value), or asynchronous (Promises) and always resolve in case of promises.

For inputValidator the returned or resolved value can be:

• a falsy value (undefined, null, false) for indicating success
• a string value (error message) for indicating failure

For preConfirm the returned or resolved value can be:

• false to prevent a popup from closing
• anything else to pass that value as the result.value of Swal.fire()
• undefined to keep the default result.value

Document Swal.update() and Swal.isUpdatableParameter()

Some icons in the "Modal Types" section appear small

Using Google Chrome Version 64.0.3282.186 (Official Build) (64-bit)

Add Swal.getTimerLeft() documentation

Connected to sweetalert2/sweetalert2#1117

Document validationMessage

validationMessage has been added in sweetalert2/sweetalert2#1227

Add documentation for onAfterClose

Related release: https://github.com/sweetalert2/sweetalert2/releases/tag/v7.17.0

@Baune8D could you please submit the PR with the documentation for onAfterClose?

Document available SASS variables

Add variables from https://github.com/sweetalert2/sweetalert2/blob/master/src/variables.scss should be documented

After documenting SASS variables we should consider them as the part of public API and apply semver rules when adding/changing anything in variables.scss

Site Organization and Navigation

Currently everything is on one page, with no way to navigate to different sections. In order to find the section you're looking for, you will probably have to do a lot of scrolling and scanning. The site would be improved a lot if there was a navbar to fix this.

Seems this was the main reason for opening sweetalert2/sweetalert2#711