{"id":15713548,"url":"https://github.com/luckyframework/lucky_hxml","last_synced_at":"2025-08-23T10:35:01.719Z","repository":{"id":199063812,"uuid":"701570582","full_name":"luckyframework/lucky_hxml","owner":"luckyframework","description":"Similar to LuckyHTML, but for Hyperview (https://hyperview.org/).","archived":false,"fork":false,"pushed_at":"2023-10-16T21:18:33.000Z","size":33,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T18:46:36.096Z","etag":null,"topics":["crystal","hyperview","luckyframework"],"latest_commit_sha":null,"homepage":"https://crystaldoc.info/github/luckyframework/lucky_hxml","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luckyframework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-07T00:14:56.000Z","updated_at":"2023-12-30T06:58:53.000Z","dependencies_parsed_at":"2024-10-24T10:51:18.874Z","dependency_job_id":"1a507d1a-45ff-4b2a-b1d9-9f6d9862d496","html_url":"https://github.com/luckyframework/lucky_hxml","commit_stats":null,"previous_names":["mdwagner/lucky_hxml"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/luckyframework/lucky_hxml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_hxml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_hxml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_hxml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_hxml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luckyframework","download_url":"https://codeload.github.com/luckyframework/lucky_hxml/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luckyframework%2Flucky_hxml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271746658,"owners_count":24813575,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crystal","hyperview","luckyframework"],"created_at":"2024-10-03T21:32:04.477Z","updated_at":"2025-08-23T10:35:01.688Z","avatar_url":"https://github.com/luckyframework.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LuckyHXML\n\nSimilar to LuckyHTML, but for [Hyperview](https://hyperview.org/).\n\n## Installation\n\n1. Add the dependency to your `shard.yml`:\n\n  ```yaml\n  dependencies:\n    lucky_hxml:\n      github: luckyframework/lucky_hxml\n      version: ~\u003e 0.1\n  ```\n\n2. Run `shards install`\n\n## Add to Lucky\n\n1. Add the dependency to `src/shards.cr`:\n\n  ```crystal\n  require \"lucky\"\n  require \"avram/lucky\"\n  # ...\n  require \"lucky_hxml\"\n  ```\n\n2. Add a `src/components/base_hxml_component.cr` file:\n\n  ```crystal\n  abstract class BaseHXMLComponent \u003c LuckyHXML::Component\n  end\n  ```\n\nSynonymous with [Lucky Components](https://luckyframework.org/guides/tutorial/components#what-are-components)\n\n3. Add a `src/screens/main_screen.cr` file:\n\n  ```crystal\n  abstract class MainScreen \u003c LuckyHXML::Screen\n  end\n  ```\n\nSynonymous with [Lucky HTML](https://luckyframework.org/guides/frontend/rendering-html#intro-to-lucky-html)\n\n4. Include in `BrowserAction` (or any `Lucky::Action`) and modify `accepted_formats`:\n\n  ```crystal\n  abstract class BrowserAction \u003c Lucky::Action\n    # ...\n    include LuckyHXML::Renderable\n\n    accepted_formats [:html, :json, :xml], default: :html\n    #                               ^^^^\n  end\n  ```\n\n## Usage\n\n### Create a Screen\n\n```crystal\nclass HomeScreen \u003c MainScreen\n  def render\n    doc do\n      screen do\n        styles do\n          style id: \"body\", flex: \"1\", backgroundColor: \"white\"\n        end\n        body style: \"body\" do\n          view do\n            text \"Welcome!\"\n          end\n        end\n      end\n    end\n  end\nend\n```\n\n### Create a Component\n\n```crystal\nclass PhoneBehaviorComponent \u003c BaseHXMLComponent\n  needs trigger : String = \"press\"\n  needs phone_number : String\n\n  def render\n    behavior(\n      \"xmlns:comms\": \"https://hypermedia.systems/hyperview/communications\",\n      trigger: trigger,\n      action: \"open-phone\",\n      \"comms:phone-number\": phone_number\n    )\n  end\nend\n```\n\n#### Create Custom Elements\n\nYou can create custom elements and attributes with `element` \u0026 `attribute` methods respectively.\n\n```crystal\nclass SwipeRowComponent \u003c BaseHXMLComponent\n  def render(\u0026)\n    element \"swipe:row\" do\n      swipe_namespace\n      yield\n    end\n  end\n\n  private def swipe_namespace : Nil\n    attribute \"xmlns:swipe\", \"https://hypermedia.systems/hyperview/swipeable\"\n  end\nend\n```\n\n### Mount a Component\n\n```crystal\nmount PhoneBehaviorComponent, phone_number: \"123-456-7890\"\n```\n\nWith a block:\n\n```crystal\nmount SwipeRowComponent do\n  # ...\nend\n```\n\n### Render a Screen\n\n```crystal\nclass Home::Index \u003c BrowserAction\n  get \"/\" do\n    # Same as `html` macro\n    hxml HomeScreen\n  end\nend\n```\n\n### Render a Component\n\n```crystal\nclass Home::Index \u003c BrowserAction\n  get \"/\" do\n    # Same as `component` method\n    hxml_component PhoneBehaviorComponent, phone_number: \"111-222-3333\"\n  end\nend\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckyframework%2Flucky_hxml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluckyframework%2Flucky_hxml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluckyframework%2Flucky_hxml/lists"}