github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/examples/component-choice/README.md (about)

     1  import ExampleYAML from "@site/src/components/ExampleYAML";
     2  
     3  # Component Choice
     4  
     5  :::caution
     6  
     7  Component Choice is currently a [Deprecated Feature](../../docs/9-roadmap.md#alpha). This feature will be removed in Jackal v1.0.0. Please migrate any existing packages you may have that utilize it.  In doing so you may want to consider [Package Flavors](../package-flavors/README.md) as an alternative.
     8  
     9  :::
    10  
    11  This example demonstrates how to define packages that can be chosen by the user on `jackal package deploy`.  This is done through the `group` key inside of the component specification that defines a group of components a user can select from.
    12  
    13  A package creator can also use the `default` key to specify which component will be chosen if a user uses the `--confirm` flag.
    14  
    15  :::note
    16  
    17  A user can only select a single component in a component group and a package creator can specify only a single default
    18  
    19  A component in a component `group` cannot be marked as being `required`
    20  
    21  :::
    22  
    23  ## `jackal.yaml` {#jackal.yaml}
    24  
    25  :::info
    26  
    27  To view the example in its entirety, select the `Edit this page` link below the article and select the parent folder.
    28  
    29  :::
    30  
    31  <ExampleYAML src={require('./jackal.yaml')} showLink={false} />