0.0.1
This commit is contained in:
98
resources/[core]/esx_notify/readme.md
Normal file
98
resources/[core]/esx_notify/readme.md
Normal file
@@ -0,0 +1,98 @@
|
||||
`<h1 align='center'>`[ESX] Notify`</a>``</h1>``<p align='center'>``<b>``<a href='https://discord.esx-framework.org/'>`Discord`</a>` - `<a href='https://esx-framework.org/'>`Website`</a>` - `<a href='https://docs.esx-framework.org/legacy/installation'>`Documentation`</a>``</b>``</h5>`
|
||||
|
||||
A beautiful and simple NUI notification system for ESX
|
||||
|
||||
# Example Code
|
||||
|
||||
`<h3>`Change style and time`</h3>`
|
||||
|
||||
```lua
|
||||
---usage: message/type/length
|
||||
ESX.ShowNotification("message here", "error", 3000)
|
||||
ESX.ShowNotification("message here", "success", 3000)
|
||||
ESX.ShowNotification("message here", "info", 3000)
|
||||
ESX.ShowNotification("message here", "warning", 3000)
|
||||
|
||||
ESX.ShowNotification("text here") -- Default will time and type will be info/3000
|
||||
|
||||
-- With title (optional 4th parameter)
|
||||
ESX.ShowNotification("message here", "success", 3000, "Achievement")
|
||||
|
||||
--[[
|
||||
With position (optional 5th parameter)
|
||||
Possible positions:
|
||||
"top-right"
|
||||
"top-left"
|
||||
"top-middle"
|
||||
"bottom-right"
|
||||
"bottom-left"
|
||||
"bottom-middle"
|
||||
"middle-left"
|
||||
"middle-right"
|
||||
]]
|
||||
ESX.ShowNotification("Your message here", "info", 3000, "Info Title", "top-right")
|
||||
```
|
||||
|
||||
`<h3>`Export Usage`</h3>`
|
||||
|
||||
```lua
|
||||
-- Basic usage
|
||||
exports["esx_notify"]:Notify("info", 3000, "message here")
|
||||
|
||||
-- With title
|
||||
exports["esx_notify"]:Notify("success", 3000, "Item purchased!", "Shop")
|
||||
|
||||
-- With position
|
||||
exports["esx_notify"]:Notify("warning", 4000, "Inventory full!", "Warning", "bottom-left")
|
||||
|
||||
-- With line break
|
||||
exports["esx_notify"]:Notify("warning", 4000, "Inventory full!~br~Some items were dropped.", "Warning")
|
||||
```
|
||||
|
||||
`<h3>`Event Usage`</h3>`
|
||||
|
||||
```lua
|
||||
-- Basic usage
|
||||
TriggerEvent("ESX:Notify", "info", 3000, "message here")
|
||||
|
||||
-- With title
|
||||
TriggerEvent("ESX:Notify", "error", 5000, "You don't have enough money!", "Transaction Failed")
|
||||
|
||||
-- With position
|
||||
TriggerEvent("ESX:Notify", "success", 4000, "Welcome!", "Greetings", "top-middle")
|
||||
```
|
||||
|
||||
`<h3>`Color Code Usage`</h3>`
|
||||
|
||||
```lua
|
||||
~r~ = Red
|
||||
~b~ = Blue
|
||||
~g~ = Green
|
||||
~y~ = Yellow
|
||||
~p~ = Purple
|
||||
~c~ = Grey
|
||||
~m~ = Dark Grey
|
||||
~u~ = Black
|
||||
~o~ = Orange
|
||||
|
||||
ESX.ShowNotification("I i ~r~love~s~ donuts", "success", 3000)
|
||||
|
||||
-- Line break example
|
||||
ESX.ShowNotification("You received ~br~1x ~g~ball~s~!", "success", 3000, "Item Received")
|
||||
```
|
||||
|
||||
# Previews
|
||||
|
||||

|
||||
|
||||
## Legal
|
||||
|
||||
esx_notify- Notify!
|
||||
|
||||
Copyright (C) 2022-2024 ESX-Framework
|
||||
|
||||
This program Is free software: you can redistribute it And/Or modify it under the terms Of the GNU General Public License As published by the Free Software Foundation, either version 3 Of the License, Or (at your option) any later version.
|
||||
|
||||
This program Is distributed In the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty Of MERCHANTABILITY Or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License For more details.
|
||||
|
||||
You should have received a copy Of the GNU General Public License along with this program. If Not, see `<http://www.gnu.org/licenses/>`.
|
||||
Reference in New Issue
Block a user