LCFS - Create Ag Grid variation that allows input rows / data entry

[justin-lepitzki]

Describe the task This card is to create a variation of AG grid that allows input rows, including:

• data entry into individual cells/rows
• ability for certain fields to be: drop-down menus, calendar picker, pill selection (see wireframe)
• simple validation, per field validation
• Adding individual rows
• Calculations to occur across different fields; for example, field 3 within a row will be the product of field 1 and field 2
• Ability to make some fields not editable

Wireframe: https://preview.uxpin.com/59145260c7d8cc48969ac79401cc03d84843c3d9#/pages/165712417/simulate/no-panels

Purpose This component will be used in many features within the LCFS portal to facilitate data entry and the completion of forms, including fuel codes, compliance reporting, etc. This task will ensure that AG Grid has the functionality required for use within these features. If it does not, we will have to explore other options.

Acceptance Criteria

1. Data Entry Capabilities:

   • Users must be able to enter data into individual cells and rows within the AG Grid.
   • The grid should support text input, numeric values, date entries, and dropdown options.

2. Custom Field Types:

   • Certain fields must be configurable as dropdown menus, allowing users to select from predefined options.
   • Some fields should employ a calendar picker for date selection.
   • Other fields must offer a pill selection mechanism, enabling users to choose one or more predefined options in a tag-like fashion.

3. Validation:

   • Each field must have simple validation rules applied (e.g., required fields, numeric constraints, date formats).
   • Validation errors should be displayed in a user-friendly manner, prompting the user for correction.

4. Dynamic Row Addition and Calculations:

   • Users must be able to add new rows to the grid dynamically.
   • Automatic calculations across fields within a row must be supported (e.g., a field's value being the product of two other fields).

5. Editable/Non-Editable Fields:

   • The grid must allow certain fields to be marked as non-editable, preventing users from modifying their contents.

6. Integration and Usability:

   • The custom AG Grid variation must integrate seamlessly with the LCFS portal, supporting the required functionalities for fuel codes, compliance reporting, etc.
   • The component must perform efficiently, with no significant impact on the overall performance of the portal.

Development Checklist

• [ ] Setup and Initial Configuration:

  • [ ] Create a new AG Grid variation module within the LCFS portal codebase.
  • [ ] Configure basic AG Grid settings to enable data entry.

• [ ] Custom Cell Editors:

  • [ ] Implement dropdown menu cell editor.
  • [ ] Implement calendar picker cell editor.
  • [ ] Implement pill selection cell editor.

• [ ] Validation:

  • [ ] Define validation rules for each field type.
  • [ ] Implement validation logic and error messaging.

• [ ] Dynamic Rows and Calculations:

  • [ ] Add functionality for dynamically adding new rows.
  • [ ] Implement logic for automatic field calculations as specified.

• [ ] Editable/Non-Editable Fields:

  • [ ] Configure certain fields as non-editable based on requirements.

• [ ] Integration Testing:

  • [ ] Integrate the custom AG Grid variation into the LCFS portal.
  • [ ] Conduct thorough testing to ensure all functionalities work as expected and meet the acceptance criteria.

• [ ] Documentation:

  • [ ] Document the setup, configuration, and usage instructions.
  • [ ] Ensure the documentation covers how to add new fields or change existing configurations.

• [ ] Review and Finalization:

  • [ ] Review the implementation with stakeholders or through code review processes.
  • [ ] Make any necessary adjustments based on feedback.

[justin-lepitzki]

The team estimates this card as an 8 if Prashanth is the one to complete it. This is because he has been our lead on AG Grid related work. If another dev were to take this card, the team believes the estimate should be a 13.