catechism 0.0.9

The catechism library is a framework for creating a catechism (question and answer learning tool) application.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.0.9

Fixed

• The drawer should now show up on the list page again.
• The spacing on the references page has been improved.

0.0.8

Added

• An optional show/hide answer button on the question details page.
• A new references "pop up" page to show referenced source material.

Changed

• The references tab is now a pop up page and has configuration settings (replacing some of the removed tab configuration setting) for the following:
  • displayQuestionReferences - if "false" the icon in the bottom bar for references will not appear
  • questionReferencesIcon - allows the icon displayed in the bottom bar for references to be customized

Removed

• The image tab (the questions can still have images, they just aren't shown anywhere currently).
• The tab bar related configuration settings.

0.0.7

Added

• Question details page is now optional. Either the details page will be used, or the list will contain the answers in-line. This is controlled through the "displayQuestionDetailsAsSeparatePage" configuration flag, which defaults to true (so, previous behavior is the default).
• The leading (question short title) in the question list item is now wrapped in a CircleAvatar. The background color can be set using the "primaryColorLight" property of the theme, and the text color can be set using the "color" property of the "headlineMedium" property of the theme. By setting the background color to the same color as the "scaffoldBackgroundColor" property, the CircleAvatar will effectively disappear.

Changed

• Text widgets that used the "headlineMedium" style (info screen titles and question details titles) now use "headlineLarge" instead.
• Leading (question short title) now uses the "headlineMedium" style

0.0.6

Changed

• improved dart docs
• make question title truly optional (i.e. nullable)
• add question short title (titleShort) optional field and use it instead of displaying question id to better support languages/locales other than English

0.0.5

Added

• more dart docs

0.0.4

Added

• some function level dart docs for the generated API reference docs
• GitHub actions to test and publish

0.0.3

Added

• references for Questions
• image for Question
• bottom navigation bar (tabs) on details page
• tab for showing scripture references/text for a given question
• tab for showing an image for a given question

0.0.2

Added

• dartdoc comments for all classes

Changed

• updated the library description to be more descriptive

0.0.1

Initial Version

Added

• CatechismApp Widget, including the following:
  • app title
  • catechism question list screen
  • catechism detail screen with question and answer
  • drawer with links to additional info screens
  • custom theming
  • configuration (turning on/off the following features):
    • displaying the question number in the details screen
    • displaying the question title in the details screen