Progress

The Phoenix LiveView Progress component is a highly customizable and versatile component designed for creating visually dynamic progress bars including horizontal, vertical, ring, and semi-circle progress indicators.

This Phoenix LiveView component also supports advanced features like chunked progress bars, allowing you to visually represent multiple stages of progress within a single bar. Additionally, the gradient variant adds dynamic styling, enabling smooth color transitions that enhance the visual appeal of your progress indicators.

The default variant of the progress component offers a wide range of color options to suit different design needs. You can customize the progress bar's appearance by choosing from the following colors: white, primary, secondary, dark, success, warning, danger, info, silver, misc, and dawn. These options ensure that your progress bar can seamlessly integrate with your application's overall color scheme.

<.progress variant="default" color="natural" />
<.progress variant="default" color="white" />
<.progress variant="default" color="primary" />
<.progress variant="default" color="secondary" />
<.progress variant="default" color="dark" />
<.progress variant="default" color="success" />
<.progress variant="default" color="warning" />
<.progress variant="default" color="danger" />
<.progress variant="default" color="info" />
<.progress variant="default" color="silver" />
<.progress variant="default" color="misc" />
<.progress variant="default" color="dawn" />

The gradient variant of the progress component introduces a visually appealing gradient effect, allowing you to apply smooth transitions between colors. You can use any of the following color options for the gradient effect: natural, primary, secondary, success, warning, danger, info, silver, misc, and dawn.

<.progress variant="gradient" color="natural" />
<.progress variant="gradient" color="primary" />
<.progress variant="gradient" color="secondary" />
<.progress variant="gradient" color="success" />
<.progress variant="gradient" color="warning" />
<.progress variant="gradient" color="danger" />
<.progress variant="gradient" color="info" />
<.progress variant="gradient" color="silver" />
<.progress variant="gradient" color="misc" />
<.progress variant="gradient" color="dawn" />

The value prop shows the percentage of progress completed, ranging from 0 to 100. For example, setting the value to 50 will indicate that 50% of the task or process is complete, visually reflecting the progress on the bar.

<.progress value={4} />
<.ring_progress id="ring-progress-1" value={32} />
<.semi_circle_progress value={77} />

The variation prop allows you to define the orientation of the progress bar, with options for either horizontal or vertical. By default, the progress bar is set to horizontal, making it ideal for typical linear progress indicators. However, when vertical is selected, the progress bar is displayed in an upright format, offering a different visual representation of progress.

<!--Horizontal-->
<.progress />
<.progress variation="horizontal" />

<.progress variation="vertical" />

The size prop adjusts the visual dimensions of the progress bar for both horizontal and vertical orientations. It offers predefined options such as extra_small, small, medium, large, extra_large, double_large, triple_large, and quadruple_large. In horizontal mode, this prop changes the height of the progress bar, while in vertical mode, it adjusts the width and overall height.

<.progress size="extra_small" />
<.progress size="small" />
<.progress size="medium" />
<.progress size="large" />
<.progress size="extra_large" />
<.progress size="double_large" />
<.progress size="triple_large" />
<.progress size="quadruple_large" />

<.progress variation="vertical" size="extra_small" />
<.progress variation="vertical" size="small" />
<.progress variation="vertical" size="medium" />
<.progress variation="vertical" size="large" />
<.progress variation="vertical" size="extra_large" />
<.progress variation="vertical" size="double_large" />
<.progress variation="vertical" size="triple_large" />
<.progress variation="vertical" size="quadruple_large" />

All the previously mentioned props, can also be applied to each section when using the progress_section within the progress component.

<.progress>
  <.progress_section color="dawn" value={80} />
</.progress>

By utilizing progress_section, you can easily create chunked(or segmented) progress bars within the progress component. By defining multiple sections, each with its own value, color, and variant, you can visually segment the progress bar into distinct parts. This feature allows for more granular representation of progress, such as showing different stages of a process or multiple tasks within the same progress bar.

<.progress>
  <.progress_section csp_nonce={@csp_nonce} color="primary" value={10} />
  <.progress_section csp_nonce={@csp_nonce} color="secondary" value={15} />
  <.progress_section csp_nonce={@csp_nonce} color="misc" value={10} />
  <.progress_section csp_nonce={@csp_nonce} color="danger" value={5} />
  <.progress_section csp_nonce={@csp_nonce} color="warning" value={10} />
  <.progress_section csp_nonce={@csp_nonce} color="success" value={10} />
  <.progress_section csp_nonce={@csp_nonce} color="info" value={5} />
</.progress>

<!--Vertical-->
<.progress
  variation="vertical"
  size="w-5 h-[350px]"
>
  <.progress_section value={60} csp_nonce={@csp_nonce} variation="vertical">
  </.progress_section>
  <.progress_section value={30} csp_nonce={@csp_nonce} variation="vertical">
  </.progress_section>
  <.progress_section value={10} csp_nonce={@csp_nonce} variation="vertical">
  </.progress_section>
</.progress>

The label slot in the Progress module provides a flexible mechanism for embedding custom values or text within each chunk of a progress bar or the overall progress itself. This slot allows developers to include dynamic label, such as progress percentages, texts, or detailed information, directly inside the progress component.

<.progress size="extra_large">
  <.progress_section color="primary" value={10}>
    <:label class="fonte-bold">Images</:label>
  </.progress_section>
  <.progress_section color="secondary" value={5}>
    <:label class="text-white">15%</:label>
  </.progress_section>
  <.progress_section color="misc" value={30}>
   <:label class="font-bold">Other</:label>
  </.progress_section>
</.progress>

<.progress size="extra_large">
  <.progress_section csp_nonce={@csp_nonce} color="misc" value={20}>
    <:label class="font-bold">80%</:label>
  </.progress_section>
</.progress>

If you have enabled the CSP header on your website, you must pass the csp_nonce parameter when using the progress and progress_section components. The reason for this is that part of these components is written inline to avoid the need for state.

The value prop in the Ring Progress component represents the current progress percentage, accepting values from 0 to 100, where 0 indicates no progress and 100 indicates completion of the task or process.

<.progress value={4} />
<.ring_progress id="ring-progress-3" value={32} />
<.semi_circle_progress value={77} />

The max prop in the Ring Progress component allows you to customize the maximum value of the progress scale, defaulting to 100 if not specified, enabling you to work with different progress scales while maintaining proportional visual representation.

<.ring_progress id="ring-progress-4" value={30} max={60} />
<.ring_progress id="ring-progress-5" value={30} max={100} />

The size prop in the Ring Progress component controls the overall diameter of the progress indicator in pixels. The default size is 120 pixels, but you can customize this value to create smaller or larger progress indicators based on your design needs.

<.ring_progress id="ring-progress-6" value={60} size={150} />

The thickness prop adjusts the width of the progress ring's stroke, allowing you to create thinner or thicker progress indicators. The default value is 10 pixels, and you can customize it based on your design needs.

<.ring_progress id="ring-progress-7" value={60} thickness={4} />

The color prop in the Ring Progress component allows you to customize the color theme of the progress indicator. Available color options include: natural, primary, secondary, success, warning, danger, info, silver, misc, and dawn. The default value is natural.

<.ring_progress id="ring-progress-8" value={60} color="natural" />
<.ring_progress id="ring-progress-9" value={60} color="white" />
<.ring_progress id="ring-progress-10" value={60} color="primary" />
<.ring_progress id="ring-progress-11" value={60} color="secondary" />
<.ring_progress id="ring-progress-12" value={60} color="dark" />
<.ring_progress id="ring-progress-13" value={60} color="success" />
<.ring_progress id="ring-progress-14" value={60} color="warning" />
<.ring_progress id="ring-progress-15" value={60} color="danger" />
<.ring_progress id="ring-progress-16" value={60} color="info" />
<.ring_progress id="ring-progress-17" value={60} color="silver" />
<.ring_progress id="ring-progress-18" value={60} color="misc" />
<.ring_progress id="ring-progress-19" value={60} color="dawn" />

The label prop allows you to add descriptive text inside the ring progress indicator. The label appears centered within the ring, making it useful for displaying progress percentages, status messages, or other relevant information about the task being tracked.

<.ring_progress id="ring-progress-20" value={60} label="Uploading" />

The linecap prop defines how the ends of the progress bar's stroke are drawn. It accepts three values: butt (flat ends), round (rounded ends), or square (square ends that extend beyond the path). This property can significantly affect the visual appearance of your progress indicator's endpoints.

<.ring_progress id="ring-progress-21" value={60} linecap="butt" />
<.ring_progress id="ring-progress-22" value={60} linecap="round" />
<.ring_progress id="ring-progress-23" value={60} linecap="square" />

The Semi Circle Progress component creates a visually appealing half-circle shape to display progress, with customizable features like size, thickness, orientation, colors, and labels.

<.semi_circle_progress value={60} />

The value prop in the Semi Circle Progress component represents the current progress percentage, accepting values from 0 to 100. For example, setting value={50} indicates that 50% of the task or process is complete. The progress arc will draw accordingly from 0% to the specified value, providing a clear visual representation of the completion status.

<.semi_circle_progress value={20} />

The size prop in the Semi Circle Progress component controls the overall diameter of the progress indicator in pixels. The default size is 200 pixels, but you can customize this value to create smaller or larger progress indicators based on your design needs.

<.semi_circle_progress value={60} size={150} />

The thickness prop in the Semi Circle Progress component controls the width of the progress arc. The default value is 12 pixels, and you can adjust it to create thinner or thicker progress indicators based on your design requirements. For example, setting thickness={6} creates a thinner line, while thickness={14} creates a thicker one.

<.semi_circle_progress value={60} thickness={2} />

The orientation prop in the Semi Circle Progress component determines the direction the semi-circle faces. It accepts two values: up (default) where the arc points upward, or down where the arc points downward. This allows you to create versatile progress indicators that can be oriented according to your design needs.

<.semi_circle_progress value={60} orientation="up" />
<.semi_circle_progress value={60} orientation="down" />

The fill_direction prop in the Semi Circle Progress component determines the direction in which the progress arc is drawn. It accepts two values: left-to-right (default) or right-to-left. This allows you to customize the animation direction of the progress indicator to match your design preferences or to create visual variety in your interface.

<.semi_circle_progress value={60} fill_direction="left-to-right"/>
<.semi_circle_progress value={60} fill_direction="right-to-left" />

The transition_duration prop in the Semi Circle Progress component controls the animation speed when the progress value changes. It accepts a value in milliseconds, where a higher number results in a slower, smoother transition and a lower number creates a faster transition. The default value is 300 milliseconds, which provides a balanced animation speed suitable for most use cases.

<.semi_circle_progress value={60} transition_duration={150} />

The linecap prop in the Semi Circle Progress component determines how the ends of the progress arc are rendered. It accepts three values: butt (flat ends), round (rounded ends), or square (square ends that extend beyond the path). This styling option can significantly impact the visual appearance of your progress indicator's endpoints, allowing you to choose between sharp or smooth transitions.

<.semi_circle_progress value={60} linecap="butt" />
<.semi_circle_progress value={60} linecap="round" />
<.semi_circle_progress value={60} linecap="square" />

The color prop in the Semi Circle Progress component allows you to customize the color theme. Available color options include: natural, primary, secondary, success, warning, danger, info, silver, misc, and dawn. If not specified, it defaults to natural.

<.semi_circle_progress value={60} color="natural" />
<.semi_circle_progress value={60} color="white" />
<.semi_circle_progress value={60} color="primary" />
<.semi_circle_progress value={60} color="secondary" />
<.semi_circle_progress value={60} color="dark" />
<.semi_circle_progress value={60} color="success" />
<.semi_circle_progress value={60} color="warning" />
<.semi_circle_progress value={60} color="danger" />
<.semi_circle_progress value={60} color="info" />
<.semi_circle_progress value={60} color="silver" />
<.semi_circle_progress value={60} color="misc" />
<.semi_circle_progress value={60} color="dawn" />

The label prop enables you to add descriptive text to display alongside the progress indicator, providing context or status information about the progress being shown.

<.semi_circle_progress value={60} label="Uploading" />

The :tooltip slot allows you to show contextual information when hovering or clicking on a progress section. You can define a label as the trigger, and customize position, style, and interaction behavior. This is especially useful when multiple progress sections are used and you want to provide additional information for each segment.

Available attributes for the :tooltip slot:

• label: Required. Text or UI element that acts as the tooltip trigger.
• position: Optional. Defines where the tooltip appears relative to the trigger. Supported values: "top", "bottom", "left", "right". Default: "top". use "left" and "right" for vertical variation
• clickable: Optional. If set to true, tooltip shows on click instead of hover.
• class: Optional. Additional custom classes for tooltip content styling.

<.progress size="extra_large">
  <.progress_section color="primary" value={10}>
    <:tooltip label="Images" position="top" class="font-bold">
      Tooltip content for Images
    </:tooltip>
  </.progress_section>

  <.progress_section color="secondary" value={5}>
    <:tooltip label="15%" position="bottom" class="text-white">
      Only 5% left
    </:tooltip>
  </.progress_section>

  <.progress_section color="misc" value={30}>
    <:tooltip label="Other" position="top" clickable={true} class="font-bold">
      This section represents other files
    </:tooltip>
  </.progress_section>
</.progress>

<.progress size="extra_large">
  <.progress_section csp_nonce={@csp_nonce} color="misc" value={20}>
    <:tooltip label="80%" position="right" clickable={true} class="font-bold">
      80% of content processed
    </:tooltip>
  </.progress_section>
</.progress>

<!--Vertical-->
<.progress
  variation="vertical"
  size="w-5 h-[350px]"
>
  <.progress_section value={60} csp_nonce={@csp_nonce} variation="vertical">
    <:tooltip label="1" position="right">Step 1</:tooltip>
  </.progress_section>
  <.progress_section value={30} csp_nonce={@csp_nonce} variation="vertical">
    <:tooltip label="2" position="right">Step 2</:tooltip>
  </.progress_section>
  <.progress_section value={10} csp_nonce={@csp_nonce} variation="vertical">
    <:tooltip label="3" position="right">Step 3</:tooltip>
  </.progress_section>
</.progress>