module Lucky::Renderable

Direct including types

• Lucky::Action
• Lucky::ErrorAction

Defined in:

Instance Method Summary

• #component(comp : Lucky::BaseComponent.class, status : Int32 | Nil = nil, **named_args) : Lucky::TextResponse

  Render a Component as an HTML response.

• #component(comp : Lucky::BaseComponent.class, status : HTTP::Status, **named_args) : Lucky::TextResponse
• #data(data : String, content_type : String = "application/octet-stream", disposition : String = "attachment", filename : String | Nil = nil, status : Int32 | Nil = nil) : Lucky::DataResponse
• #file(path : String, content_type : String | Nil = nil, disposition : String = "attachment", filename : String | Nil = nil, status : Int32 | Nil = nil) : Lucky::FileResponse
• #file(path : String, content_type : String | Nil = nil, disposition : String = "attachment", filename : String | Nil = nil, status : HTTP::Status = HTTP::Status::OK) : Lucky::FileResponse
• #head(status : Int32) : Lucky::TextResponse
• #head(status : HTTP::Status) : Lucky::TextResponse
• #html_content_type

  The default global content-type header for HTML

• #json(body, status : Int32 | Nil = nil, content_type : String = json_content_type) : Lucky::TextResponse
• #json(body, status : HTTP::Status, content_type : String = json_content_type) : Lucky::TextResponse
• #json_content_type

  The default global content-type header for JSON

• #plain_content_type

  The default global content-type header for Plain text

• #plain_text(body : String, status : Int32 | Nil = nil, content_type : String = plain_content_type) : Lucky::TextResponse
• #plain_text(body : String, status : HTTP::Status, content_type : String = plain_content_type) : Lucky::TextResponse
• #raw_json(body : String, status : Int32 | Nil = nil, content_type : String = json_content_type) : Lucky::TextResponse

  allows json-compatible string to be returned directly

• #raw_json(body : String, status : HTTP::Status, content_type : String = json_content_type) : Lucky::TextResponse
• #send_text_response(body : String, content_type : String, status : Int32 | Nil = nil) : Lucky::TextResponse
• #xml(body : String, status : Int32 | Nil = nil, content_type : String = xml_content_type) : Lucky::TextResponse
• #xml(body, status : HTTP::Status, content_type : String = xml_content_type) : Lucky::TextResponse
• #xml_content_type

  The default global content-type header for XML

Macro Summary

• disable_cookies

  Disable cookies

• html(page_class = nil, _with_status_code = 200, **assigns)

  Render a page and pass it data

• html_with_status(page_class, status, **assigns)

  Render an HTMLPage with a status other than 200

Instance Method Detail

get "/foo" do
  component MyComponent, with: :args
end

Macro Detail

class Events::Show < ApiAction
  disable_cookies

  get "/events/:id" do
    ...
  end
end

class Users::IndexPage < MainLayout
  needs users : UserQuery

  def content
    @users.each do |user|
      # ...
    end
  end
end

class Users::Index < BrowserAction
  get "/users" do
    html IndexPage, users: UserQuery.new
  end
end

class Users::Index < BrowserAction
  expose current_user

  get "/users" do
    # Users::IndexPage receives users AND current_user
    html IndexPage users: UserQuery.new
  end

  private def current_user
    # ...
  end
end

class SecretAgents::Index < BrowserAction
  get "/shhhh" do
    html_with_status IndexPage, 472, message: "This page can only be seen with special goggles"
  end
end