مستندات

لیست دسته ها و محتواها

Portal.Message

از این متد برای نمایش انواع پیغام ها به کاربر استفاده می شود، از جمله پیغام خطا یا موفقیت یا اخطار و ... .

طریقه استفاده از متد:

Portal.Message (Options);

ورودی های تابع

نام نوع پیشفرض تعریف
Options Object

{
  "Status": "e",
  "Position": "mc",
  "Title": "پیش فرض",
  "Text": "این پیام تستی میباشد",
  "Duration": 5000,
  "Theme": "light",
  "MaxWidth": 300,
  "Rtl": true,
  "DisplayMode": 2,
  "Buttons": [],
  "TransitionIn": "fadeInUp",
  "TransitionOut": "fadeOut",
  "Class": "",
  "beforeMethod": null,
  "afterMethod": null
}

تنظیمات را دریافت میکند، از جمله رنگ، آیکون و متن پیغام، عنوان و غیره.

Options

نام نوع پیشفرض تعریف
Status String "e" وضعیت پیغام را مشخص می کند.
i پیغام اطلاع رسانی با رنگ آبی
s پیغام موفقیت با رنگ سبز
e پیغام خطا با رنگ قرمز
w پیغام اخطار با رنگ نارنجی
q پیغام پرسش بار رنگ زرد
Position String "mc" موقعیت نمایش پیام را مشخص می کند.
br پایین و راست
bl پایین و چپ
bc پایین و وسط
tr بالا و راست
tl بالا و چپ
tc بالا و وسط
mc وسط صفحه
Title String "پیش فرض" عنوان پیغام را مشخص می کند.
Text String "این پیام تستی میباشد" متن پیغام را مشخص می کند.
Rtl Boolean true راست چین یا چپ چین بودن را مشخص میکند.
DisplayMode Number 2 شیوه نمایش را مشخص می کند
1 در صورتی که پیغام تکراری ارسال شود، فقط یکبار آن را نمایش میدهد
2 در صورتی که پیغام تکراری ارسال شود، آن را جایگزین پیغام قبل می کند و نمایش می دهد.
Duration Number 5000 مدت زمانی که نمایش پیغام طول می کشد، بر حسب میلی ثانیه. در صورتی که مقدار 0 داشته باشد، پیغام تا زمانی که کاربر روی دکمه بستن کلیک نکند، باکس نمایش پیغام، نمایش داده می شود.
MaxWidth Number 300 بیشترین عرضی که باکس پیغام میگیرد، بر حسب پیکسل (px).
Theme String 'light' رنگ متون و آیکون های باکس پیغام.
light رنگ متون مشکی می شوند
dark رنگ متون سفید می شوند
Class String '' کلاس یا کلاس هایی که به باکس نمایش پیغام اعمال می شود.
beforeMethod Function null تابعی که قبل از نمایش پیغام اجرا می شود.
afterMethod Function null تابعی که پس از بسته شدن باکس پیغام اجرا می شود.
TransitionIn String "fadeInUp" نحوه نمایش باکس پیغام در شروع نمایش، که شامل مقادیر زیر میتواند باشد:
fadeIn
fadeInUp
fadeInDown
fadeInLeft
fadeInRight
bounceInUp
bounceInDown
bounceInRight
bounceInLeft
flipInX
TransitionOut String "fadeOut" نحوه نمایش باکس پیغام، هنگام پایان دادن نمایش:
fadeOut
fadeOutUp
fadeOutDown
fadeOutRight
fadeOutLeft
flipOutX
Buttons Array [] در این آرایه دکمه هایی که میخواهیم در باکس نمایش دهیم را تعریف میکنیم.
به این صورت که هر دکمه خود یک آرایه است و شامل دو ایندکس است. که ایندکس اول حاوی کد html دکمه و ایندکس دوم تابعی که با کلیک روی آن دکمه اجرا می شود.

Portal.SuccessMessage

این متد پیغام موفقیت با رنگ سبز را با متنی که دریافت می کند به کاربر نمایش می دهد.

طریقه استفاده از متد:

Portal.SuccessMessage (Title, Text);

ورودی های تابع

نام نوع تعریف
Title String عنوان پیغام
Text String متن پیغام

Portal.ErrorMessage

این متد پیغام خطا با رنگ قرمز را با متنی که دریافت می کند به کاربر نمایش می دهد.

طریقه استفاده از متد:

Portal.ErrorMessage (Title, Text);

ورودی های تابع

نام نوع تعریف
Title String عنوان پیغام
Text String متن پیغام