mirror of
https://github.com/Hilbis/Hilbish
synced 2025-06-08 05:22:02 +00:00
88 lines
9.4 KiB
HTML
88 lines
9.4 KiB
HTML
<!doctype html>
|
|
<html class="bg-stone-50 dark:bg-neutral-900 text-black dark:text-white"><head><meta content="width=device-width, initial-scale=1.0" name="viewport"><link href="/tailwind.css" rel="stylesheet"><title>Hilbish</title><meta content="#ff89dd" name="theme-color"><meta content="/hilbish-flower.png" property="og:image"><meta content="Hilbish" property="og:title"><meta content="Hilbish" property="og:site_name"><meta content="website" property="og:type"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." property="og:description"><meta content="Something Unique. Hilbish is the new interactive shell for Lua fans. Extensible, scriptable, configurable: All in Lua." name="description"><meta content="Lua,Shell,Hilbish,Linux,zsh,bash" name="keywords"><meta content property="og:url"></head><body class="min-h-screen flex flex-col"><nav class="flex sticky top-0 w-full z-50 border-b border-b-zinc-300 backdrop-blur-md h-12"><div class="flex my-auto px-2"><div><a class="flex items-center gap-1" href="/"><img class="h-6" src="/hilbish-flower.png"><span class="self-center text-2xl">Hilbish</span></a></div></div></nav><div class="flex flex-col"><div class="h-10 flex py-2 px-4 border-b border-b-zinc-300 w-full gap-2 backdrop-blur-sm bg-zinc-300/50 dark:bg-zinc-800/50 z-50"><label class="cursor-pointer" for="sidebar-toggle"><tag><svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 -960 960 960" width="24px" class="fill-black"><path d="M120-240v-80h240v80H120Zm0-200v-80h480v80H120Zm0-200v-80h720v80H120Z"/></svg></tag></label><span>Module hilbish.messages</span></div><div class="grid"><input class="peer hidden" id="sidebar-toggle" type="checkbox"><div class="border-r border-r-zinc-300 col-start-1 row-start-1 sticky top-22 sm:top-12 h-full sm:h-svh bg-neutral-200 dark:bg-neutral-900 basis-3/5 transition-transform duration-300 -translate-x-full peer-checked:translate-x-0 z-30"><div class="p-4 -mb-4 overflow-y-auto h-full"><h2 class="text-xl font-semibold mb-4">Sidebar</h2><ul><li class="mb-2">Vim Mode</li><li class="mb-2">Completions</li><li class="mb-2">Lunacolors</li><li class="mb-2">Frequently Asked Questions</li><li class="mb-2">Getting Started</li><li class="mb-2">Introduction</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module fs</li><li class="mb-2">Module snail</li><li class="mb-2">Module terminal</li><li class="mb-2">Module commander</li><li class="mb-2">API</li><li class="mb-2">Module bait</li><li class="mb-2">Module hilbish.module</li><li class="mb-2">Module hilbish.abbr</li><li class="mb-2">Module hilbish.userDir</li><li class="mb-2">Module hilbish.os</li><li class="mb-2">Module hilbish.history</li><li class="mb-2">Module hilbish.completion</li><li class="mb-2">Module hilbish.messages</li><li class="mb-2">Module hilbish.aliases</li><li class="mb-2">Module hilbish.runner</li><li class="mb-2">Module hilbish.timers</li><li class="mb-2">Module hilbish</li><li class="mb-2">Module hilbish.jobs</li><li class="mb-2">Module hilbish.editor</li><li class="mb-2">Actions</li><li class="mb-2">Module doc</li><li class="mb-2">Nature</li><li class="mb-2">Module dirs</li><li class="mb-2">Hilbish</li><li class="mb-2">Command</li><li class="mb-2">Signals</li><li class="mb-2">Signal</li><li class="mb-2">Notification</li><li class="mb-2">Runner Mode</li><li class="mb-2">Options</li><li class="mb-2">Features</li></ul></div></div><main class="col-start-1 row-start-1 transition-all duration-300 peer-checked:filter peer-checked:blur-sm peer-checked:bg-black/30 px-4 pt-2"><h1 class="font-bold text-4xl">Module hilbish.messages</h1><h2 class="font-bold text-3xl" id="Introduction-The-messages-interface-defines-a-way-for-Hilbish-integrated-commands-user-config-and-other-tasks-to-send-notifications-to-alert-the-user.z-The-hilbish.message-type-is-a-table-with-the-following-keys:-title-(string):-A-title-for-the-message-notification.-text-(string):-The-contents-of-the-message.-channel-(string):-States-the-origin-of-the-message-hilbish.*-is-reserved-for-Hilbish-tasks.-summary-(string):-A-short-summary-of-the-text.-icon-(string):-Unicode-(preferably-standard-emoji)-icon-for-the-message-notification-read-(boolean):-Whether-the-full-message-has-been-read-or-not.">Introduction
|
|
The messages interface defines a way for Hilbish-integrated commands,
|
|
user config and other tasks to send notifications to alert the user.z
|
|
The <code>hilbish.message</code> type is a table with the following keys:
|
|
<code>title</code> (string): A title for the message notification.
|
|
<code>text</code> (string): The contents of the message.
|
|
<code>channel</code> (string): States the origin of the message, <code>hilbish.*</code> is reserved for Hilbish tasks.
|
|
<code>summary</code> (string): A short summary of the <code>text</code>.
|
|
<code>icon</code> (string): Unicode (preferably standard emoji) icon for the message notification
|
|
<code>read</code> (boolean): Whether the full message has been read or not.</h2><h2 class="font-bold text-3xl" id="Functions-|||-|----|----|-|<a-href="unreadCount">unreadCount()</a>|Returns-the-amount-of-unread-messages.|-|<a-href="send">send(message)</a>|Sends-a-message.|-|<a-href="readAll">readAll()</a>|Marks-all-messages-as-read.|-|<a-href="read">read(idx)</a>|Marks-a-message-at-idx-as-read.|-|<a-href="delete">delete(idx)</a>|Deletes-the-message-at-idx.|-|<a-href="clear">clear()</a>|Deletes-all-messages.|-|<a-href="all">all()</a>|Returns-all-messages.|-<hr>-<div-id='all'>-<h4-class='heading'>-hilbish.messages.all()-<a-href="all"-class='heading-link'>- <i-class="fas-fa-paperclip"></i>-</a>-</h4>">Functions
|
|
|||
|
|
|----|----|
|
|
|<a href="#unreadCount">unreadCount()</a>|Returns the amount of unread messages.|
|
|
|<a href="#send">send(message)</a>|Sends a message.|
|
|
|<a href="#readAll">readAll()</a>|Marks all messages as read.|
|
|
|<a href="#read">read(idx)</a>|Marks a message at <code>idx</code> as read.|
|
|
|<a href="#delete">delete(idx)</a>|Deletes the message at <code>idx</code>.|
|
|
|<a href="#clear">clear()</a>|Deletes all messages.|
|
|
|<a href="#all">all()</a>|Returns all messages.|
|
|
<hr>
|
|
<div id='all'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.all()
|
|
<a href="#all" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></h2><p>Returns all messages.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div></p><p><hr>
|
|
<div id='clear'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.clear()
|
|
<a href="#clear" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Deletes all messages.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div></p><p><hr>
|
|
<div id='delete'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.delete(idx)
|
|
<a href="#delete" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Deletes the message at <code>idx</code>.
|
|
#### Parameters
|
|
<code>idx</code> **<code>number</code>** </p><p></div></p><p><hr>
|
|
<div id='read'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.read(idx)
|
|
<a href="#read" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Marks a message at <code>idx</code> as read.
|
|
#### Parameters
|
|
<code>idx</code> **<code>number</code>** </p><p></div></p><p><hr>
|
|
<div id='readAll'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.readAll()
|
|
<a href="#readAll" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Marks all messages as read.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div></p><p><hr>
|
|
<div id='send'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.send(message)
|
|
<a href="#send" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Sends a message.
|
|
#### Parameters
|
|
<code>message</code> **<code>hilbish.message</code>** </p><p></div></p><p><hr>
|
|
<div id='unreadCount'>
|
|
<h4 class='heading'>
|
|
hilbish.messages.unreadCount()
|
|
<a href="#unreadCount" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4></p><p>Returns the amount of unread messages.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
</div></p></main></div></div><footer class="py-4 px-6 flex flex-row justify-around border-t border-t-zinc-300"><div class="flex flex-col"><a class="flex items-center gap-1" href><img class="h-24" src="/hilbish-flower.png"><span class="self-center text-6xl">Hilbish</span></a><span class="text-xl">The Moon-powered shell!</span><span class="text-light text-neutral-500">MIT License, copyright sammyette 2025</span></div><div class="flex flex-col"><a href="https://github.com/Rosettea/Hilbish"><span class="text-pink-300 text-light">GitHub</span></a></div></footer></body></html> |