Go

To display something in Ray use the ray.Ray() function. It accepts everything: strings, maps, booleans, ... you name it.

ray.Ray("a string")

ray.Ray(true)

ray([]int{2,3,4})

ray.Ray() accepts multiple arguments. Each argument will be displayed in the Ray app.

ray.Ray("as", "many" , "arguments", "as", "you", "like")

You can colorize things you sent to ray by using one of the color functions.

ray.Ray("this is green").Green()
ray.Ray("this is orange").Orange()
ray.Ray("this is red").Red()
ray.Ray("this is blue").Blue()
ray.Ray("this is purple").Purple()
ray.Ray("this is gray").Gray()

screenshot

Ray can display things in different sizes.

ray.Ray("small").Small()
ray.Ray("regular")
ray.Ray("large").Large()

screenshot

You can use NewScreen (or ClearScreen) to programmatically create a new screen.

ray.Ray().NewScreen("")

You can see values that were previously displayed, by clicking the little back button in the header of Ray.

Optionally, you can give a screen a name:

ray.Ray().NewScreen("My debug screen")

screenshot

You could opt to use NewScreen very early on in a request so you'll only see items that were sent to Ray in the current request.

To clear the current screen and all previous screens, call ClearAll.

ray.Ray().ClearAll()

You can pause execution of a script by using the Pause method.

ray.Ray().Pause()

screenshot

If you press the "Continue" button in Ray, execution will continue. When you press "Stop execution", Ray will throw an exception in your app to halt execution.

If you are using Windows, you must set the maximum execution time to a high value, as the paused time will count against the maximum execution time.

Ray can display information about a date in a nicely formatted table using the Time() method.

ray.Ray().Time(time.Now())

You can also format the date different than the Go's default format by using TimeWithFormat()

ray.Ray().TimeWithFormat(time.Now(), "01-02-2006 15:04:05")

To display an image, call the image function and pass either a fully-qualified url as its only argument.

ray.Ray().Image("https://placekitten.com/200/300")

To render a piece of HTML directly in Ray, you can use the Html method.

ray.Ray().Html("<b>Bold string<b>")

You can update values that are already displayed in Ray. To do this, you must hold on the instance returned by the ray function and call send on it.

Here's an example where you'll see a countdown from 10 to one.

myRay := ray.Ray("counting down!")

for i := 0; i < 10; i++ {
	time.Sleep(1)
	myRay.Send(2)
}

The instance $ray may also be used to add a color or size to items already on display. Here's an example where an items will change color and size after a second

myRay := ray.Ray("a string")

time.Sleep(1)

myRay.Red().Large()

You can conditionally show things using the ShowIf method. If you pass a truthy value, the item will be displayed.

ray.Ray("will be show").ShowIf(true)
ray.Ray("will not be shown").ShowIf(false)

You can also pass a callable to ShowIf. If the callable returns a truthy value, it will be shown. Otherwise, it will not.

You can remove an item that is already displayed in Ray. To do this, call the Remove function on an instance return by the ray function.

ray := ray.Ray("will be removed after 1 sec")

time.Sleep(time.Second)

ray.Remove()

You can also conditionally remove items with the RemoveWhen function (or the RemoveIf alias).

ray.Ray("this one will be remove if the number is 2").RemoveWhen(num == 2);

RemoveWhen also accepts a callable that returns a boolean.

ray.Ray("this one will be remove if the number is 2").RemoveWhen(func () bool { ... } // return true to remove the item);

You can display something in ray and make it hidden immediately.

ray.Ray().Hide()

screenshot

You can use Ray to display a notification.

ray.Ray().Notify('This is my notification')

screenshot

You can stop the Go process by calling die.

ray.Ray().Die()

You can show and hide the Ray app via code.

ray.Ray().ShowApp() // Ray will be brought to the foreground
ray.Ray().HideApp() // Ray will be hidden

You can enable and disable sending stuff to Ray with the Enable and Disable functions.

ray.Ray("one") // will be displayed in ray

ray.Ray().Disable()

ray.Ray("two") // won't be displayed in ray

ray.Ray().Enable()

ray.Ray("three") // will be displayed in ray

You can check if Ray is enabled or disabled with the Enabled and Disabled functions.

ray.Ray().Disable()

ray.Ray().Enabled() // false
ray.Ray().Disabled() // true

ray.Ray().Enable()

ray.Ray().Enabled() // true
ray.Ray().Disabled() // false