메인 콘텐츠로 건너뛰기
OrderBySelect는 목록 페이지에서 정렬 기준을 선택하는 자동 생성 컴포넌트입니다. 백엔드의 OrderBy enum을 기반으로 생성되며, 한글 레이블이 자동으로 매핑됩니다.

핵심 기능

자동 생성

Entity 정의에서 자동 생성OrderBy enum 기반

한글 레이블

자동 레이블 매핑“ID최신순”, “생성일오름차순” 등

useListParams 통합

register 패턴 지원URL 동기화 자동

커스터마이징

스캐폴딩 파일자유로운 수정 가능

자동 생성 조건

OrderBySelect는 백엔드에 OrderBy enum이 정의되면 자동으로 생성됩니다.

백엔드 정의

자동 생성되는 파일

위치: web/src/components/user/UserOrderBySelect.tsx 자동 생성되는 레이블: web/src/services/sonamu.generated.ts
레이블 생성 규칙
  • id-desc → “ID최신순”
  • created_at-asc → “생성일오래된순”
  • username-desc → “이름내림차순”
필드명과 정렬 방향(asc/desc)을 조합하여 자동 생성됩니다.

기본 사용법

useListParams와 함께 사용

동작:
  1. 사용자가 정렬 옵션 선택
  2. register("orderBy")가 자동으로 URL 업데이트
  3. API 호출 시 listParams.orderBy가 전달됨
  4. 백엔드에서 정렬 적용

Props

기본 사용 (register 없이)

Props 상세

placeholder

선택되지 않았을 때 표시되는 텍스트입니다.

textPrefix

각 옵션 앞에 붙는 접두사입니다.
textPrefix 활용 예시목록 페이지 상단에 현재 정렬을 명확히 표시하고 싶을 때 유용합니다:

clearable

“전체” 옵션을 추가하여 정렬을 초기화할 수 있습니다.
사용 시나리오:
  • 기본 정렬로 돌아가고 싶을 때
  • 정렬 없이 데이터베이스 순서대로 보고 싶을 때

disabled

컴포넌트를 비활성화합니다.

className

Tailwind CSS 클래스를 추가합니다.

실전 예제

완전한 목록 필터

모바일 반응형

정렬 옵션 수 표시

커스터마이징

OrderBySelect는 스캐폴딩 파일이므로 자유롭게 수정할 수 있습니다.

레이블 변경

아이콘 추가

특정 옵션 숨기기

그룹화

백엔드 처리

OrderBySelect에서 선택한 값은 백엔드로 전달되어 실제 정렬이 적용됩니다.

Model에서 처리

exhaustive 패턴

exhaustive()는 모든 경우를 처리했는지 컴파일 타임에 검증합니다.

재생성

OrderBySelect는 초기 생성 후 자동 재생성되지 않습니다.

재생성이 필요한 경우

  1. 컴포넌트 파일을 삭제한 경우
  2. Entity의 OrderBy enum이 크게 변경된 경우

재생성 방법

재생성 시 주의커스터마이징한 내용은 재생성 시 사라집니다. 중요한 수정 사항은 별도로 백업하거나 문서화하세요.

문제 해결

OrderBySelect가 생성되지 않음

원인: 백엔드에 OrderBy enum이 정의되지 않음 해결:

레이블이 한글로 표시되지 않음

원인: sonamu.generated.ts가 재생성되지 않음 해결:

선택해도 정렬이 적용되지 않음

원인: 백엔드 Model에서 orderBy 처리 누락 해결: user.model.ts의 findMany에서 params.orderBy를 처리하세요.

관련 문서