Icons
~~~~~

*Overview*

There are a number of icons in use within the various applications, mainly as a visual prefix for buttons, although there is a number of other uses.
Below is a list of the known icons in use.

.. code-block:: sh
   :caption: Typical use of an icon for a button

    import AddIcon from '@mui/icons-material/Add';

    <BaseButton
      ...
      icon={<AddIcon />}
      ...
    />

.. note:: sh

   The word Icon has been appended to the components where missing to aid with code clarity, but this is optional to the developer

.. csv-table:: Properties
   :header: "import URL", "Icon component", "description"

   "@mui/icons-material/Add", "<AddIcon />", "Mathematical plus symbol"   
   "@mui/icons-material/ArrowBackIosIcon", "<ArrowBackIosIcon />", "Arrow pointing right-to-left"
   "@mui/icons-material/ArrowForwardIos", "<ArrowForwardIosIcon />", "Arrow pointing left-to-right"
   "@mui/icons-material/Brightness4", "<Brightness4Icon />", "Light mode icon, used in the standard Header"
   "@mui/icons-material/Brightness7", "<Brightness7Icon />", "Dark mode icon, used in the standard Header"
   "@mui/icons-material/Clear", "<ClearIcon />", "Indicates a cancellation of an action"
   "@mui/icons-material/Check", "<CheckIcon />", "Star indicating a selected/important item"
   "@mui/icons-material/DeleteRounded", "<DeleteIcon />", "Trash car indicating a delete function"
   "@mui/icons-material/Description", "<DescriptionIcon />", "Document button, used in the standard Header"
   "@mui/icons-material/Done", "<DoneIcon />", "Tick icon, currently used on StatusIcon component"
   "@mui/icons-material/DownloadRounded", "<DownloadIcon />", "Download/pull something into the application"
   "@mui/icons-material/Email", "<EmailIcon />", "Postal letter for notification to the user"
   "@mui/icons-material/EditRounded", "<EditIcon />", "Pencil indicating an edit function"
   "@mui/icons-material/FactCheck", "<FactCheckIcon />", "Document with a tick indicating validation"
   "@mui/icons-material/FileCopyRounded", "<FileCopyIcon />", "Copy/clone a file"
   "@mui/icons-material/Help", "<HelpIcon />", "Help icon used in the Standard Header"
   "@mui/icons-material/HighlightOff", "<HighlightOffIcon  />", "Copyright icon, used in the standard Footer"
   "@mui/icons-material/Home", "<HomeIcon />", "Return to home page"
   "@mui/icons-material/MyLocation", "<MyLocation />", "Used on the PHT resolve button to indicate a point in space is retrieved"
   "@mui/icons-material/PictureAsPdf", "<PictureAsPdfIcon />", "Indicates PDF document"
   "@mui/icons-material/Publish", "<PublishIcon />", "Upload/Submit/publish to file"
   "@mui/icons-material/Save", "<SaveIcon />", "Save of the object, text or content"
   "@mui/icons-material/Search", "<SearchIcon />", "Standard magnifying glass search icon"
   "@mui/icons-material/UploadFile", "<UploadFileIcon />", "Upload of a file"
   "@mui/icons-material/VisibilityRounded", "<ViewIcon />", "Eye to indicate a view of some item"