--- - component: BaseButton source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/base_button.rb parameters: - name: tag type: Symbol default: "`:button`" description: One of `:a`, `:button`, or `:summary`. - name: type type: Symbol default: "`:button`" description: One of `:button`, `:reset`, or `:submit`. - name: size type: Symbol default: "`:md`" description: One of `:lg`, `:md`, `:sm`, `:xl`, or `:xs`. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Blankslate source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/blankslate_component.rb parameters: - name: tag type: Symbol, String default: "`:div`" description: The rendered tag name - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Body source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/body_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Button source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/button_component.rb parameters: - name: tag type: Symbol default: "`:button`" description: One of `:a`, `:button`, or `:summary`. - name: type type: Symbol default: "`:button`" description: One of `:button`, `:reset`, or `:submit`. - name: scheme type: Symbol default: "`:default`" description: One of `:danger`, `:default`, `:info`, `:success`, or `:warning`. - name: size type: Symbol default: "`BaseButton::DEFAULT_SIZE`" description: One of `:lg`, `:md`, `:sm`, `:xl`, or `:xs`. - name: type type: Symbol default: "`:button`" description: One of `:button`, `:reset`, or `:submit`. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: ClipboardCopy source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/clipboard_copy_component.rb parameters: - name: tag type: Symbol, String default: "`:clipboard-copy`" description: The rendered tag name - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: value type: String default: '`""`' description: Text to copy into the users clipboard when they click the component. - name: for_id type: String default: "`nil`" description: If `value` is not provided, the element with this id will be copied. - name: aria_label type: String default: '`""`' description: Text for accessibility. Can also be passed in as part of `attributes`, but it must be present. - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Comment source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/comment_component.rb parameters: - name: action type: String default: N/A description: The action to take when the form is submitted. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Container source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/container_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Counter source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/counter_component.rb parameters: - name: tag type: Symbol, String default: "`:span`" description: The rendered tag name - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: count type: Integer, Float::INFINITY, nil default: "`0`" description: 'The number to be displayed (e.x. # of issues, pull requests)' - name: limit type: Integer, nil default: "`9_000`" description: Maximum value to display. Pass `nil` for no limit. (e.x. if `count` == 6,000 and `limit` == 5000, counter will display "5,000+") - name: hide_if_zero type: Boolean default: "`false`" description: If true, a `hidden` attribute is added to the counter if `count` is zero. - name: text type: String default: '`""`' description: Text to display instead of count. - name: round type: Boolean default: "`false`" description: Whether to apply rounding logic to value. - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Flash source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/flash_component.rb parameters: - name: tag type: Symbol, String default: "`:div`" description: The rendered tag name. - name: dismissible type: Boolean default: "`false`" description: Whether the component can be dismissed with an X button. - name: icon type: Symbol, String default: N/A description: Name of [Heroicon](https://ariadne.style/heroicons/) to use. - name: scheme type: Symbol default: "`:default`" description: One of `:danger`, `:default`, `:info`, `:success`, or `:warning`. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Flex source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/flex_component.rb parameters: - name: tag type: Symbol, String default: "`:div`" description: The rendered tag name. - name: type type: Symbol default: N/A description: One of `:column`, `:column_reverse`, `:row`, or `:row_reverse`. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Footer source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/footer_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Grid source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/grid_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Header source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/header_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Heading source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/heading_component.rb parameters: - name: tag type: String default: "`nil`" description: One of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, or `:h6`. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Heroicon source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/heroicon_component.rb parameters: - name: tag type: Symbol, String default: "`:svg`" description: The rendered tag name - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: icon type: Symbol, String default: N/A description: Name of [Heroicon](https://ariadne.style/heroicons/) to use. - name: variant type: String default: N/A description: One of `outline` and `solid`. - name: size type: Symbol default: "`:sm`" description: One of `:sm` (`16`), `:md` (`24`), or `:lg` (`128`). - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - name: text_classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: text_attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Image source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/image_component.rb parameters: - name: tag type: Symbol, String default: "`:img`" description: The rendered tag name - name: src type: String default: N/A description: The source url of the image. - name: alt type: String default: N/A description: Specifies an alternate text for the image. - name: lazy type: Boolean default: "`false`" description: Whether or not to lazily load the image. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: InlineFlex source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/inline_flex_component.rb parameters: - name: tag type: Symbol, String default: "`:span`" description: The rendered tag name - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Link source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/link_component.rb parameters: - name: tag type: String default: "`:a`" description: One of `:a` and `:span`. - name: href type: String default: N/A description: URL to be used for the link. - name: actionable type: Boolean default: "`false`" description: If true, adds additional classes to the link to make it more aware. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: List source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/list_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Main source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/main_component.rb parameters: - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Pill source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/pill_component.rb parameters: - name: tag type: Symbol, String default: "`:span`" description: The rendered tag name. - name: color type: String default: N/A description: The hex color of the pill. - name: classes type: String default: '`""`' description: "[Classes and attributes](/classes-attributes)" - name: attributes type: Hash default: "`{}`" description: "[Classes and attributes](/classes-attributes)" - component: Slideover source: https://github.com/yettoapp/ariadne/ruby/view_components/tree/main/app/components/ariadne/slideover_component.rb parameters: - name: tag type: Symbol, String default: "`:div`" description: The rendered tag name. - name: direction type: Symbol default: N/A description: One of `:xl` and `:yd`. - name: form_id type: String default: "`nil`" description: The ID of any