Go to file
Jacques Ikot 3b1c14a9f0
feat: add sortBy property to table select cell type (#35187)
## Description
**Problem**
The table widget now supports the Select column type, which allows the
column to contain both a label and a value. This could be useful for
currency fields, foreign keys, or any other case where you want to
display a different version of the column value. However, there is a
problem with sorting. The table always sorts using the value, and does
not give the user an option to sort using the label, where it makes
sense in specific cases.

**Solution**
This PR adds a Sort By property to the table select cell, allowing the
users to choose which value is used for sorting without affecting any
functionality of the label or value of the select cell.

[Additional Technical
Documentation](https://www.notion.so/appsmith/Adding-sortBy-Property-to-Select-Columns-in-Table-Widget-V2-a5a41e6319a047378eb50a42be8c32ef?pvs=4)

**Tested Cases**
1. Sort select column by default value
Objective: Ensure that a newly added table with select column default
sorts by the value
**Steps:**
- Drop a new table widget.
- Add sample data to the table.
- Set a column (e.g., role) to select type.
- Add selectOptions property
- Verify that when sorted in ascending or descending order, the sorting
is correct

2. Sort select column by label
Objective: Ensure that a newly added table with select column and sortBy
property set to label sorts correctly
**Steps:**
- Drop a new table widget.
- Add sample data to the table.
- Set a column (e.g., role) to select type
- Add selectOptions property
- Set sortBy property to label
- Verify that when sorted in ascending or descending order, the sorting
is correct and based on the label value only

3. Verify that sorting of other table cells that are not select works as
expected
Objective: Ensure that every other cell type in the table sorts
correctly
**Steps:**
- Drop a new table widget.
- Add sample data to the table.
- Set a column (e.g., role) to select type
- Add selectOptions property
- Set sortBy property to label
- Verify that when columns other that role are sorted, they are sorted
correctly

4. Verify that sorting works as expected when table data is a binding
Objective: Ensure that the sorting works for all columns while using
data binding in table data
**Steps:**
- Drop a new table widget
- Link a query binding to the table data property
- Verify that all columns sort correctly

5. Verify that sorting works as expected when table data is a binding
and select column sorting is set to label
Objective: Ensure that the sorting works for all columns while using
data binding in table data with a select column set to sort by the label
**Steps:**
- Drop a new table widget
- Link a query binding to the table data property
- Set a column (e.g., role) to select type
- Add selectOptions property
- Set sortBy property to label
- Verify that all columns sort correctly

6. Verify that sortBy logic does not take effect or break user
experience until the user adds selectOptions in select cell
**Steps:**
- Drop a new table widget
- Link a query binding to the table data property or add raw data
- Set a column (e.g., role) to select type
- Do not add selectOptions
- Set sortBy property to label
- Verify that all other columns display and sort correctly

7. Verify that sorting by label and value works correctly in deployed
mode
**Steps:**
- Drop a new table widget
- Link a query binding to the table data property or add raw data
- Set a column (e.g., role) to select type
- Add selectOptions
- Set sortBy property to label
- Deploy application
- Confirm that sorting works correctly for all columns

Fixes #21993 

## Automation

/ok-to-test tags="@tag.Table, @tag.Binding, @tag.Sanity"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/10165119164>
> Commit: 8a4e8b238adc0d78726a811b54a209caa4990606
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=10165119164&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.Table, @tag.Binding, @tag.Sanity`
> Spec:
> <hr>Tue, 30 Jul 2024 16:02:35 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [x] Yes
- [ ] No


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit


- **New Features**
	- Introduced a feature flag for dynamic table cell labeling.
- Added a sorting option for select cells, allowing sort by value or
label.
- Enhanced user interface with new configuration options for select
components.
	- Improved sorting functionality for select columns to sort by labels.

- **Bug Fixes**
- Improved sorting functionality in the table widget to ensure accurate
data representation.

- **Tests**
- Expanded and clarified test cases for sorting functionality in the
Table Widget V2.
- Updated testing structure for better reliability and isolation of test
scenarios.
	- Integrated dynamic testing capabilities based on feature flags.

- **Documentation**
- Added new locators for sorting controls to enhance UI interaction
capabilities.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-08-02 08:37:00 +01:00
.github chore: reverted client profiled build (#35306) 2024-07-31 15:23:08 +05:30
app feat: add sortBy property to table select cell type (#35187) 2024-08-02 08:37:00 +01:00
contributions Update CodeContributionsGuidelines.md 2024-07-31 17:47:44 +05:30
deploy fix: cleanup stale postgres postmaster.pid (#35171) 2024-07-26 12:52:49 +05:30
scripts fix failing dps (#34625) 2024-07-02 12:36:40 +05:30
static Add files via upload 2023-08-11 19:09:51 +05:30
utils/observability
.coderabbit.yaml chore: Adding coderabbit config file (#34955) 2024-07-16 21:08:20 +05:30
.deepsource.toml
.editorconfig chore: Python files use 4-space indentation 2023-09-15 14:55:43 +05:30
.env.example chore: Remove unused services (#30292) 2024-01-23 05:43:16 +05:30
.gitignore chore: Include version in info.json and remove fields that aren't being useful (#27288) 2023-09-15 15:50:23 +05:30
.imgbotconfig
.nojekyll
app.json test: Enable server tests for the PRs with base PG branch (#33429) 2024-05-22 15:55:20 +05:30
appsmith_events.md
appsmith_templates.md
ci-debug.sh
CODE_OF_CONDUCT.md
CODEOWNERS chore: Adding my name as codeowner (#34725) 2024-07-05 17:05:12 +05:30
CONTRIBUTING.md
depot.json
Dockerfile chore: Logs and potential fix for CI startup flakiness (#34461) 2024-06-25 14:03:56 +05:30
heroku.yml
IssuesReport.md
LICENSE
README.md Update top contributors 2023-11-17 06:55:30 +05:30
SECURITY.md

Appsmith Logo

Discord GitHub commit activity


Organizations build internal applications such as dashboards, database GUIs, admin panels, approval apps, customer support dashboards, and more to help their teams perform day-to-day operations. Appsmith is an open-source tool that enables the rapid development of these internal apps. Read more on our website.

Appsmith in 100 secs

Installation

There are two ways to start using Appsmith:

  • Signup on Appsmith Cloud.
  • Install Appsmith on your machine. See the installation guides below.
Installation Methods Documentation
Docker Docker (Recommended)
Kubernetes Kubernetes
AWS AWS AMI

For other deployment options, see the Installation Guides documentation.

Development

To build and run Appsmith in your local dev environment, see Setup for local development.

Learning Resources

Need Help?

Contributing

We ❤️ our contributors. We're committed to fostering an open, welcoming, and safe environment in the community.

📕 We expect everyone participating in the community to abide by our Code of Conduct. Please read and follow it.
🤝 If you'd like to contribute, start by reading our Contribution Guide.
👾 Explore some good first issues.

Let's build great software together.

Top Contributors

Nikhil-Nandagopal mohanarpit sharat87 hetunandu trishaanand riodeuno nidhi-nair vicky-primathon Aishwarya-U-R satbir121 sumitsum AnaghHegde arunvjn NandanAnantharamu ankitakinger nayan-rafiq abhvsn jsartisan Rishabh-Rathod ohansFavour sbalaji1192 sarojsarab SatishGandham AmanAgarwal041 prsidhu ayushpahwa sneha122 ApekshaBhosale Parthvi12 yatinappsmith somangshu pratapaprasanna pranavkanade albinAppsmith marks0351 nsarupr ashit-rath NilanshBansal sondermanish KelvinOm dhruvikn rajatagrawal areyabhishek subrata71 ichik dipyamanbiswas07 rahulbarwal ankitsrivas14 vsvamsi1 brayn003 sharanya-appsmith vivonk dvj1988 ramsaptami rohan-arthur jacquesikot danciaclara kocharrahul7 riteshkew srix laveena-en RakshaKShetty Rishabhkaul sandeepravi tejasahluwalia dilippitchika nerbos rlnorthcutt kevinblanco AbhaySM tomjose92 andreevanatasha LagunaElectric sribalajig infinitetrooper RoopKrrish9696 bharath31 GreenFlux shadabbuchh harshilp24 appsmith-bot momcilo-appsmith shwetha-ramesh vasanthappsmith parth-appsmith chandannkumar jnikhila vinay-appsmith ame-appsmith btsgh Sripriya93 pranayagarwal96 kamakshibhat-appsmith sujdev7 BharghaviK carinanfonseca deepikaappsmith Harshask93 cssonic kavitasmoolya NeelPattani1 rashmi-sahoo-git michael-peach-appsmith akash-codemonk Tooluloope rishabhsaxena wmdev0808 Irongade techbhavin yaldram aswathkk rahulramesha sidhantgoel Vijetha-Kaja haojin111 berzerkeer sum35h ChandanBalajiBP devrk96 keyurparalkar eco-monk vibhandikyash ofpiyush vishnu-gp rimildeyjsr tanvibhakta rashmigowda55 ankurrsinghal Druthi geekup-legodevops megaconfidence vihar danieldare Nikhil-Curefit souma-ghosh arslanhaiderbuttar tkAppsmith rashmi-rai leotom2000 ravikp7 Adityaacharya1807 RashmiNagarajp prapullac kaushik94 PiyushPushkar02 akshayrangasaid mojtab23 rohitagarwal88 iamakulov iamrkcheers sumanthyedoti shubham7saxena7 vaibh1297 vnodecg pc9795 Rhitottam Pranay105 iSatVeerSingh abm17 akshay11298 daniel-shuy daniloff200 osis harshitpandey0426 ganganimaulik jyash97 ram-primathon sub1983 sanjus-robotic-studio AR10X shreemaan-abhishek A-Scratchy gitstart-appsmith manish535 shinnlok suhasranganath ThakurKarthik trdillon acharyaaditya18 amogh2019 appsmithguru pric-appsmith sunil-codemonk abhiappsmith ajinkyakulkarni Cool-Runningz akbansa ArjobanSingh bharat-patodi Bhavin789 bhuvanaindukuri donno2048 jacobwgillespie reachtokish nuwan94 OmkarPh parthiv11 priyanka-mahour rafaeelaudibert samyakjain10 Jain-Sanchit irfan-ansari-au28 sheetal2001p Hard-Coder05 vj-codes knockknockyoo jdun28 alphaX86 aanchal-fatwani monarch0111 abhishekS14 adarshlilha avats-dev visibleajay blenderskool AlekSi alzaar heroic AJ-72 apoorv-mishra anvaravind ari-hacks arunstar ashwanisindhu1 ayushkumarbhadani Caitlin-Fotheringham Chiradeep-Banik chrismaeda CommanderRoot DevSnap digvijaysinghh DiptoChakrabarty felixsuarez0727 gitstart Gretel8 danguilherme harshmange44 indrajitbnikam ishaanmehta4 jaikanthjay46 jarimayenburg JarLob JeffResc jmakhack jlund jrcamelo khoahuynhdev kylegalbraith loiscodes jk2K micarner me-heer MuhammadAakash dammahhammad moulik-deepsource Nandanha wasabigeek nipun1999 nishihere19 Nitesh2905 eagleera NoxiousPenguin palashkaria pallavagarwal07 paususe neok sanchezpili6 pushkar1393 imor ricardocarrola RishiKumarRay Rooney30 Saket2 Sheikh-JamirAlam withshubh smrutiparida somnathdasadhikari srijanshetty Sufiyan1997 rayrny trishitapingolia trivikr webdott vasanthkumar18 VanshajPoonia vedant-pandey torcoste vvkpd yasharma2301 Yash-Bhange YogeshJayaseelan Ian-Yy danceAndJive devnamrits deepakchethan IAmAnubhavSaini gokuatkai Jackenmen Mrxyy zimkjh kyteinsky lifeneedspassion nikhil-babar nupur-singhal1992 nzidol onifs10 ps-xaf

License

Appsmith is licensed under the terms of Apache License 2.0.