{@image }
A tool template that corresponds to the input style that the
user selects.
This allows people to respond to prompts with video,
text, sketch, or voice recording.
Flutter icons
Copyright (C) 2021 by original authors @ fluttericon.com, fontello.com
This font was generated by FlutterIcon.com, which is derived from Fontello.
This is the information that Aureus pulls to fill in vital information in
the templates we provide. Be sure to fill ALL of it out before you start
developing.
A navigation tree that holds all of the values about what widgets
to call in different templates. When Aureus uses a template screen for you,
the entry and exit points from specific templates will come from this navigation tree.
This is where all of the gradients, text styles, colors, and other related items
are located in Aureus. Since they are global items, you can call them without
accessing them through any specific class.
A custom wrapper of a material app that allows Aureus to handle custom accessibility,
safety, privacy, and accessibility changes. This also simplifies a lot of the information
that goes into our templates, and allows you to basically set these variables and
develop incredibly quickly.
A class to hold custom branding and colors for the UI items generated
by Aureus. Each 'mode' has a different stylization, so you'll create
one for light mode and one for dark mode.
An observer pattern that the ToolTemplateCardCarouselView
uses to receive instructions from the ToolTemplateCards on moving
forward / going backward, depending on the interaction that the
user takes on the card.
A helper class that creates flattened variables to access all of the
information gathered from AureusResource without making the code unbearable
to read.
A set of classes that dynamically create BoxDecorations in accordance with the
design system principles for each kind of interactivity.
Some classes have their own custom variants that further differentiate them.
Every backing decoration inherits from the Parent - Base Backing Decoration.
{@image }
The base class for a card tool template.
A CARD is a tool template that doesn't take up a full page, and
is accessed within a card carousel only. It's used in conjunction with
other cards, not as a stand alone item.
{@image }
The base class for a Base Data Detail Card.
A detail card is a UI element meant for writing and reading values. These
are accessed within a DataDetailView only.
{@image }
The base class for a page tool template.
A PAGE is a tool template that uses a full page, and
is accessed within a card navigation object. It's used solo,
and NOT used within a card carousel. It's typically used for
navigating information in a tool (e.g: scrolling through saved items)
and is meant to be the scaffolding / support of a tool, not the main
tool content.
{@image }
A view that displays an article, and a checkbox.
When the user agrees to the checkbox and moves forward, it calls
the param onFinish.
This should be used for legal documents that MUST be agreed to in order
to use the software. e.g: terms of service, cookie policy, etc.
{@image }
A floating circle with a gradient that's filled according
to how complete something is. Used for showing completion
at the end of a task or action.
{@image }
A container that sets the size for the screen,
enables the exit bar at the top of the screen when enabled in
the safety plan, and shows notifications / prompts to the user.
Think of this view as the 'glue' that holds Aureus together.
{@image }
A set of objects that makes a 'tool'. Within Astra, we use this to develop
user flows for collecting incident log information, to build mental health
exercises, or to add a contact. A CoreTool can be any sort of flow or resource
for the end user.
{@image }
The data consent objects request permissions across operating systems on your behalf,
and keep them managed. However, you must still go into the native codebase
for Android / iOS and manually input what permissions you will be asking for ahead
of time, to avoid a crash. Read more about this on the permission handler documentation
under setup here: https://pub.dev/packages/permission_handler
A class that manages Data consent objects
{@image }
Object that is meant to act as the main data structure for a DataDetailView.
This contains the title, the detail cards for writing / reading, and any
CTAs to perform additional actions.
{@image }
A data detail view is similar to using CoreTools. Use a data detail view
when a user is opening up a read/write object. This can be anything from a user
settings page, to a contact page, or a log page.
{@image }
This view requests permissions from the user,
you set what permissions you want in your AureusInformation
object of the packageVariables for your application.
{@image }
A group of SmolButtonElement that acts as a tabbing bar to do actions
This is used in the Safety Functionality to allow people to quickly go
to speciality tools from any page in an Aureus Resource.
You can control which views show a Quick Action Bar (if your safety
settings enable it) within the ContainerView initializer parameters.
An object that constructs a help center article with from content. If you don't
want to include a CTA on your article, just pass null to the constructor.
It is required to be defined in the constructor, but can be built without it.
{@image }
An object that contains all of the lower level objects
If only one category is passed, Help Center will just display the
list view of articles.
If multiple categories are passed, Help Center will display a
grid list of categories, and then a detailed list of articles.
{@image }
A small, circular button that uses an icon to communicate its' purpose
big circular icon buttons that are greater than 70x70 and are intended
to be the main action of the page (e.g: add, message, etc).
{@image }
A semantics wrapper that provides a Focus node for screen readers
and tab orders to be established. This is just a little helper wrapper
to combine Focus / semantics into one overarching wrapper class.
{@image }
A transparent view that manages a AureusNotificationMaster
object, and shows / hides the notifications at the correct time.
If you aren't using ContainerView or are building a custom component
(always use ContainerView unless you plan on custom implementations), this is
the widget that you would use for the notification master.
{@image }
A view that shows an iterating component of OnboardingDetails to give
the user information about the resource before signing up. This is where you
want to discuss features and cool things about your resources.
{@image }
A view that should be where the user 'lands' if they haven't been onboarded.
This landing view gets autopopulated with the data from AureusNavigationTree.
{@image }
A view that animates gradients and noise, while scrolling through a poem.
This is an 'Easter Egg' Astra uses to hide poems within our resources for a
better user experience.
{@image }
A view that allows the user to select their safety plan choices. This is automatically
pulled from Safety, so it requires no developer input. You set what
options users can enable in your AureusInformation section of packageVariables.
{@image }
A view that allows the user to modify their Safety Plan settings. This is
automatically pulled from Safety, so it requires no developer input.
A class that builds semantics wrappers for custom UI items.
Semantics are important, because they tell assistive technology
and SEO crawlers information about the underlying elements.
{@image }
The class that makes up a settings section, which is a grouping of similar
settings together.
A minimum of 1 setting sections are required to build a SettingsView object.
{@image }
A view that's meant to allow the user to modify the settings of the resource.
Some of these items are autopopulated from your AureusInformation in the
packageVariables you set.
{@image }
A templatized splash screen view. This is the first view your users should
see, and where you should run any downloading / onboarding logic checks.
{@image }
A vertical navigation bar, meant to be used on tablet / web displays.
If you use this, and have a ContainerView as a subchild, make sure to set
ContainerView.managesNotifications as false.
Whether a button is the primary button size (the top 'call to action'
of a page) or a secondary (not top call to action). The different
sizes make it easier for users to prioritize what to do, and provides
better UX. Primary is the biggest as a main call to action, and smolBaby
is the smallest (e.g: an exit button for a sub-item, like a card).
Describes how to set the layout for the greater ContainerView.
You can set a limit to the screen height with fullScreen,
and build your layout with spacers, or you can use a stackScroll
to automatically put content in a scroll view to go past the
device screen height.
{@category Foundation}
This is where the text styles are, and the text widgets that accompany them.
Items here also go through the coloration class to be properly rendered for
each mode.
