sweetalert README

The project's README from github.com/t4t5/sweetalert. As one markdown file: README.md.

SweetAlert

A beautiful replacement for JavaScript's "alert"

npm version Build status

A success modal

Installation

$ npm install --save sweetalert

Usage

import swal from 'sweetalert';

swal("Hello world!");

Upgrading from 1.X

Many improvements and breaking changes have been introduced in the 2.0 release. Make sure you read the upgrade guide to avoid nasty surprises!

Guides

Documentation

Examples

An error message:

swal("Oops!", "Something went wrong!", "error");

A warning message, with a function attached to the confirm message:

swal({
  title: "Are you sure?",
  text: "Are you sure that you want to leave this page?",
  icon: "warning",
  dangerMode: true,
})
.then(willDelete => {
  if (willDelete) {
    swal("Deleted!", "Your imaginary file has been deleted!", "success");
  }
});

const willDelete = await swal({
  title: "Are you sure?",
  text: "Are you sure that you want to delete this file?",
  icon: "warning",
  dangerMode: true,
});

if (willDelete) {
  swal("Deleted!", "Your imaginary file has been deleted!", "success");
}

A prompt modal, where the user's input is logged:

swal("Type something:", {
  content: "input",
})
.then((value) => {
  swal(`You typed: ${value}`);
});

const value = await swal("Type something:", {
  content: "input",
});

swal(`You typed: ${value}`);

In combination with Fetch:

swal({
  text: "Wanna log some information about Bulbasaur?",
  button: {
    text: "Search!",
    closeModal: false,
  },
})
.then(willSearch => {
  if (willSearch) {
    return fetch("http://pokeapi.co/api/v2/pokemon/1");
  }
})
.then(result => result.json())
.then(json => console.log(json))
.catch(err => {
  swal("Oops!", "Seems like we couldn't fetch the info", "error");
});

const willSearch = await swal({
  text: "Wanna log some information about Bulbasaur?",
  button: {
    text: "Search!",
    closeModal: false,
  },
});

if (willSearch) {
  try {
    const result = await fetch("http://pokeapi.co/api/v2/pokemon/1");
    const json = await result.json();
    console.log(json);
  } catch (err) {
    swal("Oops!", "Seems like we couldn't fetch the info", "error");
  }
}

Using with React

SweetAlert has tools for integrating with your favourite rendering library..

If you're using React, you can install SweetAlert with React in addition to the main library, and easily add React components to your alerts like this:

import React from 'react'
import swal from '@sweetalert/with-react'

swal(
  <div>
    <h1>Hello world!</h1>
    <p>
      This is now rendered with JSX!
    </p>
  </div>
)

Read more about integrating with React

Contributing

If you're changing the core library:

  1. Make changes in the src folder.
  2. Preview changes by running npm run docs
  3. Submit pull request

If you're changing the documentation:

  1. Make changes in the docs-src folder.
  2. Preview changes by running npm run docs
  3. Run npm run builddocs to compile the changes to the docs folder
  4. Submit pull request

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

sweetalert (t4t5/sweetalert)

Searching Database…

22.2K ·GitHub
Sweetalert
Что это такое?SweetAlert — это готовая замена встроенной функции JavaScript alert(), которая показывает на веб-страницах красивые всплывающие окна: сообщения об ошибках, предупреждения и модальные окна для ввода данных.
Это целый фреймворк или просто библиотека, которую я подключаю к своей странице?Просто лёгкая фронтенд-библиотека, а не фреймворк: вы вызываете swal() там, где раньше использовали встроенный alert, а в комплекте есть ещё инструменты для интеграции с библиотеками рендеринга вроде React.
Как добавить её в свой проект?Установите пакет sweetalert из npm, а затем вызывайте swal() вместо alert(); руководства Installation и Getting started в README помогут вывести первое всплывающее окно.
Она потянет за собой кучу зависимостей?Нет — из зависимостей в рантайме только promise-polyfill и es6-object-assign, так что остаётся всё лёгким.
У меня ещё версия 1 — можно просто обновиться до 2.0?Не наобум: в релизе 2.0 много несовместимых изменений, и в README советуют сначала прочитать руководство по обновлению, чтобы не получить неприятных сюрпризов.
Это работает только в браузере или ещё и на сервере?Это клиентская веб-библиотека, заменяющая диалог alert в браузере, поэтому она живёт на веб-страницах — серверной версии или версии для Node нет.
Какие виды диалоговых окон она умеет показывать?В README показаны сообщения об ошибках, предупреждения с функцией, привязанной к кнопке подтверждения, и модальные окна ввода, которые забирают данные пользователя — включая примеры, связанные с Fetch-запросами.
Как выполнить код, когда пользователь подтвердит действие?swal() работает на промисах: можно отреагировать на выбор пользователя через .then() или через async/await — оба варианта показаны в примерах из README.
Можно ли вставить внутрь уведомлений свои React-компоненты?Да — вместе с основной библиотекой устанавливается SweetAlert with React, которая позволяет легко добавлять React-компоненты в ваши уведомления.
Можно ли изменить оформление всплывающих окон под свой сайт?Да — в документации есть отдельные разделы Configuration, Methods и Theming, так что внешний вид и поведение можно настроить.
What are similar projects?sweetalert2, material, styled-components, chakra-ui, bootstrap-table, chosen, material-components-web, Sortable
Which topics is it in?dialog, theme, javascript-library, ui-components, customization, browser, ui, web-development, free, npm, frontend, library
Creator
t4t5
Size
5.3 MB
Stars
22.2K
Updated
CommitMar 13Releasev2.1.0Dec 14
Age
12y
Commits · 90 Days