LoopOS UI v1.1.26.2

Previews

No matching results.

x
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<h1>
  You probably want to use LogList and not the singular Log component.
</h1>
<br>
<div class="lui-log" data-controller="log" data-log-expanded-copy-text-value="Expand" data-log-collapsed-copy-text-value="Collapse">
  <div class="lui-log__main">
    <div class="lui-log__main-header">
      <span class="text-secondary-xs-normal text-secondary-xs-regular text-gray-700">11:31h</span>
      <span class="text-secondary-xs-medium">Jon Doe</span>
      <span id="lui-token_5215854990" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <i class="lui-token__icon fa-regular fa-regular fa-smile"></i>
        <span class="lui-token__text">Title Token</span>
        <div class="lui-token__actions">
        </div>
      </span>
    </div>
    
    <div class="lui-log__content" data-log-target="content">
      <span id="lui-token_5793709857" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <i class="lui-token__icon fa-regular fa-regular fa-seal"></i>
        <span class="lui-token__text">Sms</span>
        <div class="lui-token__actions">
        </div>
      </span>
      <span id="lui-token_9912568611" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <img class="lui-token__icon-img" src="smile">
        <span class="lui-token__text">EntityToken</span>
        <div class="lui-token__actions">
        </div>
      </span>
      <span id="lui-token_2322156580" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <img class="lui-token__icon-img" src="smile">
        <span class="lui-token__text">EntityToken</span>
        <div class="lui-token__actions">
        </div>
      </span>
      <div class="lui-log__word">Lorem </div>
      <div class="lui-log__word">ipsum </div>
      <div class="lui-log__word">dolor </div>
      <div class="lui-log__word">sit </div>
      <div class="lui-log__word">amet, </div>
      <div class="lui-log__word">consectetur </div>
      <div class="lui-log__word">adipiscing </div>
      <div class="lui-log__word">adipiscing</div>
      <span id="lui-token_6597424226" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <img class="lui-token__icon-img" src="smile">
        <span class="lui-token__text">EntityToken</span>
        <div class="lui-token__actions">
        </div>
      </span>
      <div class="lui-log__word">Lorem </div>
      <div class="lui-log__word">ipsum </div>
      <div class="lui-log__word">dolor </div>
      <div class="lui-log__word">sit </div>
      <div class="lui-log__word">amet, </div>
      <div class="lui-log__word">consectetur </div>
      <div class="lui-log__word">adipiscing </div>
      <div class="lui-log__word">adipiscing</div>
      <span id="lui-token_8670528836" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <img class="lui-token__icon-img" src="smile">
        <span class="lui-token__text">EntityToken</span>
        <div class="lui-token__actions">
        </div>
      </span>
      <div class="lui-log__word">Lorem </div>
      <div class="lui-log__word">ipsum </div>
      <div class="lui-log__word">dolor </div>
      <div class="lui-log__word">sit </div>
      <div class="lui-log__word">amet, </div>
      <div class="lui-log__word">consectetur </div>
      <div class="lui-log__word">adipiscing </div>
      <div class="lui-log__word">adipiscing</div>
      <span id="lui-token_9451751915" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
        <img class="lui-token__icon-img" src="smile">
        <span class="lui-token__text">EntityToken</span>
        <div class="lui-token__actions">
        </div>
      </span>
    </div>
    
    <div class="lui-log__expand-content" data-log-target="expand">
      <div class="lui-log__expand-inner">
        <div class="lui-log__word">Hello </div>
        <div class="lui-log__word">from </div>
        <div class="lui-log__word">expandable </div>
        <div class="lui-log__word">content!</div>
      </div>
    </div>
    
    <div class="lui-log__buttons">
      <button class="lui-button lui-button--neutral--secondary lui-button--size-tiny w-fit w-fit" data-controller="lui--button" data-action="click->log#showMore:prevent log:toggleExpand->lui--button#rotateLeadingIcon" data-log-target="toggleExpand">
        <i class="lui-button__icon lui-button__icon--tiny fa-regular fa-chevron-down" data-lui--button-target="leadingIcon"></i>
        <span class="lui-button__text" data-lui--button-target="text">
          Expand
        </span>
      </button>
      <button class="lui-button lui-button--neutral--secondary lui-button--size-tiny w-fit w-fit" data-controller="lui--button">
        <span class="lui-button__text" data-lui--button-target="text">
          Some other button
        </span>
      </button>
      <div data-controller="modal" class="inline-flex">
        <div class="lui-modal__trigger" data-action="click->modal#open">
          <button class="lui-button lui-button--neutral--secondary lui-button--size-tiny w-fit w-fit" data-controller="lui--button">
            <i class="lui-button__icon lui-button__icon--tiny fa-regular fa-smile" data-lui--button-target="leadingIcon"></i>
            <span class="lui-button__text" data-lui--button-target="text">
              Manual Button
            </span>
          </button>
        </div>
        <dialog id="" data-modal-target="modal" style="max-width:480px;" class="lui-modal rounded-md p-0 ">
          <div class="lui-modal__wrapper">
            <div class="lui-modal__header">
              <div class="lui-title_description lui-title_description--normal">
                <span class="lui-title_description__title">
                  Modal Title
                </span>
              </div>
              <div class="-mt-1" >
                <button data-action="click->modal#close" class="cursor-pointer -mr-1 p-1">
                  <div class="lui-icon h-[10px] w-[10px]">
                    <i class="fa-regular fa-xmark lui-icon__icon" style="font-size: 10px; color: black;"></i>
                  </div>
                </button>
              </div>
            </div>
            <div class="lui-modal__content">
              Some modal content here
            </div>
            <div class="lui-modal__footer">
              <button class="lui-button lui-button--neutral--tertiary lui-button--size-small w-fit w-fit" data-controller="lui--button" data-action="click->modal#close">
                <span class="lui-button__text" data-lui--button-target="text">
                  Cancel
                </span>
              </button>
            </div>
          </div>
        </dialog>
      </div>
    </div>
  </div>
  
  <div class="lui-log__source">
    <span id="lui-token_5793709857" class="lui-token lui-entity-token lui-entity-token-general  " style="color: #212529; background-color: #F8F9FA;">
      <i class="lui-token__icon fa-regular fa-regular fa-seal"></i>
      <span class="lui-token__text">Sms</span>
      <div class="lui-token__actions">
      </div>
    </span>
  </div>
</div>

Log

Description

Used Components Components where is Used
Label

Usage rules

  • ✅ Do
  • ❌ Don't
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<h1>
    You probably want to use LogList and not the singular Log component.
</h1>
<br>
<%
  with_title_token = preview_params.delete(:with_title_token)
  log_params = preview_params
%>
<%= render LooposUi::Log.new(**log_params, date: DateTime.current) do |log| %>
  <%= log.with_source(entity: LooposUi::Entities::Sms.new(sms: OpenStruct.new(name: "Sms")))%>
  <% if with_title_token %>
    <%# log.with_title_token(entity: LooposUi::Entities::Sms.new(sms: OpenStruct.new(name: "Sms"))) %>
    <% log.with_title_entity_token(text: "Title Token", icon: "fa-regular fa-smile")%>
  <% end %>
  <%= render LooposUi::EntityToken.new(icon: :smile, text: "EntityToken") %>
  <%= render LooposUi::EntityToken.new(icon: :smile, text: "EntityToken") %>
  Lorem ipsum dolor sit amet, consectetur adipiscing adipiscing
  <%= render LooposUi::EntityToken.new(icon: :smile, text: "EntityToken") %>
  Lorem ipsum dolor sit amet, consectetur adipiscing adipiscing
  <%= render LooposUi::EntityToken.new(icon: :smile, text: "EntityToken") %>
  Lorem ipsum dolor sit amet, consectetur adipiscing adipiscing
  <%= render LooposUi::EntityToken.new(icon: :smile, text: "EntityToken") %>
  <% log.with_expand do %>
    Hello from expandable content!
  <% end %>
  <% log.with_button(text: "Some other button") %>
  <% log.with_button_manual do %>
    <%= render LooposUi::Modal.new(title: "Modal Title") do |modal|%>
      <% modal.with_trigger_button(text: "Manual Button", icon: :smile, **log.default_button_args) %>
      Some modal content here
    <% end %>
  <% end %>
<% end %>

No notes provided.

Param Description Input

Is a log error?

User name

Date

With title token?

Description

The Log component is a versatile component for displaying individual log entries with rich content, expandable sections, and interactive elements. It's designed to work within the LogList component but can also be used standalone.

The component supports various content types including text with HTML formatting, entity tokens, expandable content, and action buttons.

Arguments

Property Default Required Description
error false Whether this log represents an error state
user nil The user who performed the action
date nil The timestamp of the log entry

Slots

For content related:

  • content (default slot). Supports rich text with HTML
  • expand - For expanded content. Will create a button to expand the section.
  • button - For buttons and actions. Will create Buttons.
  • button_manual - Avoid usage, but if necessary you can pass anything into this slot.
  • source - Populates the right side of the Log. Has polymorphic options:
    • entity_token_source - Renders an EntityToken.
    • source - Alternative interface you can build an entity token and pass in as a parameter.
  • title_token (polymorphic slot) Appears to the left of the log title.
    • Can render:
    • an EntityToken
    • an entity
    • manual content

Factory System

The Log component includes a factory system that allows automatic creation of Log components from various data sources. This system provides a consistent interface for converting different data types into Log components.

How It Works

The factory system automatically detects the appropriate factory for a given data source and uses it to create a Log component. This is done through the from_any_source class method:

log = LooposUi::Log.from_any_source(my_data_source)
# Note you can also use the desired factory directly
log = LooposUi::Log::Factories::CoreItemLogPresenterHash.create(my_data_source)
# or
log = LooposUi::Log::Factories::CoreItemLogPresenterHash.try_create(my_data_source)
# returns NilLog if the factory can't create the log in production
# raises error in development

Implemented Factories

1. CoreItemLogPresenterHash

Purpose: Converts hash data from core item log presenters into Log components.

Data Source: Hash with the following structure:

{
  time: DateTime,
  author: String,
  app_instance: {
    name: String,
    kind: String
  },
  message: String,
  error: Boolean
}

2. ScriptLog

Purpose: Converts LoopOs::ScriptLog objects into Log components.

Data Source: LoopOs::ScriptLog instances with properties like:

  • created_at
  • user_identification
  • level
  • name
  • files
  • input_data

Automatic Features:

  • Download Button: Automatically added when files are present
  • Retry Button: Automatically added when input_data is present and script is a ScriptProxy with retry capability
  • Info Modal: Always included for detailed script information
  • Retry Modal: Automatically created when retry button is present

Parameters:

  • script: ScriptProxy object that provides retry functionality (optional, for retry button)

Example:

script_proxy = LoopOs::Scripts::ScriptProxy.new(@loop_os_script, context: {
  retry_path_proc: ->(script_log) { 
    rerun_script_script_path(@loop_os_script, script_log_id: script_log.id) 
  }
})
log = LooposUi::Log::Factories::ScriptLog.new(script_log, script: script_proxy).create

Creating Custom Factories

To create a custom factory, you need to:

Inherit from the base class:

class MyCustomFactory < LooposUi::Log::Factories::Base

Implement the can_create? class method:

def self.can_create?(source)
  # Return true if this factory can handle the given source
  source.is_a?(MyCustomModel)
end

Implement the create instance method:

def create
  LooposUi::Log.new(
    date: @source.created_at,
    user: @source.user_name,
    error: @source.error?
  ).with_content(@source.message)
end

Available Instance Variables in create method:

  • @source - The original data source passed to the factory constructor
  • @view_context - Available when using defer_render for complex rendering

Example: Number Factory

Here's a complete example from the dummy app showing how to create a simple factory:

module Factories
  class ExampleLogNumberFactory < LooposUi::Log::Factories::Base
    def self.can_create?(source)
      source.is_a?(Integer)
    end
    def create
      LooposUi::Log.new(
        # random time +- 5days
        date: Time.now + (3*@source).hours + 60.minutes - rand(60).minutes,
        user: "random LogNumberFactory #{@source}",
        error: rand > 0.9
      ).with_content("random message #{@source}")
    end
  end
end

Deferred Rendering

The factory create method must return a LooposUi::Log instance. But this runs before the component is rendered, so if you need to call for render, you need to use defer_render and call the view_context.render method.

def create
  log = LooposUi::Log.new(...)
  log.defer_render do |log, view_context|
    # Complex rendering logic here
    view_context.render( SomeComponent.new(...))
  end
  log
end

You have some helpers methods available if you want to build up the log incrementally:

  • with_expand_content(content)

Note if you want to render HTML directly (e.g from a partial), you need to mark it as html_safe to avoid escaping.

Check for examples in the with_custom_expand example source code.