Görünümler

Bir görünüm, bir nesnenin kayıtlarının nasıl görüntüleneceğine ilişkin kaydedilmiş bir yapılandırmadır: hangi alanların görüneceği, sıraları, görünür olup olmadıkları ve uygulanan tüm filtreler veya gruplar. Uygulamanızla önceden yapılandırılmış görünümler sunmak için defineView() kullanın. Her nesne, sunucu tarafından otomatik olarak sağlanan kendi ana liste görünümünü (bir OBJECT gezinme öğesinin açtığı “All …” tablosu) alır — buna, uygulamanızın oluşturduğu nesneler de dahildir; uygulamanızın bildirdiği her alan için bir sütunla birlikte. defineView() ile tanımladığınız görünümler, bu varsayılan görünümün üzerine eklenen her zaman ek görünümlerdir.

src/views/example-view.ts

import { defineView } from 'twenty-sdk/define';
import { EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER } from '../objects/example-object';
import { NAME_FIELD_UNIVERSAL_IDENTIFIER } from '../objects/example-object';

export default defineView({
  universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  name: 'All example items',
  objectUniversalIdentifier: EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER,
  icon: 'IconList',
  position: 0,
  fields: [
    {
      universalIdentifier: 'f926bdb7-6af7-4683-9a09-adbca56c29f0',
      fieldMetadataUniversalIdentifier: NAME_FIELD_UNIVERSAL_IDENTIFIER,
      position: 0,
      isVisible: true,
      size: 200,
    },
  ],
});

Önemli noktalar

objectUniversalIdentifier, bu görünümün hangi nesneye uygulanacağını belirtir. Bu, tanımladığınız özel bir nesne veya standart bir Twenty nesnesi olabilir.
Nesnenin ana liste görünümü sunucuya aittir: key kullanımdan kaldırılmıştır ve yok sayılır, bu nedenle bir manifest görünümü bunu asla talep edemez. Görünümünüzün kenar çubuğunda tek tık uzağınızda olmasını istiyorsanız bir VIEW gezinme öğesi ekleyin.
fields, hangi sütunların görüneceğini ve hangi sırayla görüneceğini kontrol eder. Her alan bir fieldMetadataUniversalIdentifier öğesine referans verir. Otomatik oluşturulan createdAt gibi bir sistem alanına başvurmak için bkz. Sistem Metaverilerini Hedefleme.
Daha gelişmiş yapılandırmalar için filters, filterGroups, sorts, groups ve fieldGroups da tanımlayabilirsiniz.
position, aynı nesne için birden fazla görünüm olduğunda sıralamayı kontrol eder.

İsteğe bağlı özellikler

Özellik	Değerler	Açıklama
`type`	`ViewType.TABLE` (varsayılan), `ViewType.KANBAN`, `ViewType.CALENDAR`	Kayıtların nasıl düzenlendiği. (`FIELDS_WIDGET`, `TABLE_WIDGET`, `KANBAN_WIDGET` ve `CALENDAR_WIDGET` da mevcuttur ancak sayfa düzeni bileşenleri tarafından dahili olarak kullanılır.)
`visibility`	`ViewVisibility.WORKSPACE` (varsayılan), `ViewVisibility.UNLISTED`	Görünümün tüm çalışma alanı için listelenip listelenmediği veya seçicilerden gizlenip gizlenmediği.
`openRecordIn`	kullanımdan kaldırıldı	Artık okunmuyor: Kayıtların nerede açılacağı artık object (`defineObject()` içindeki `openRecordIn`) özelliğiyle belirlenir; ayar yoksa her üyenin kendi tercihi esas alınır.
`sorts`	`{ fieldMetadataUniversalIdentifier, direction: ViewSortDirection.ASC \| DESC }[]`	Varsayılan sıralama düzeni.
`isCompact`	`boolean`	Kompakt satır görünümü.
`mainGroupByFieldMetadataUniversalIdentifier` + `shouldHideEmptyGroups`	—	Kayıtları bir alana göre gruplayın (ör. kanban sütunları).
`kanbanAggregateOperation`, `kanbanAggregateOperationFieldMetadataUniversalIdentifier`, `kanbanColumnWidth`	`AggregateOperations.*`	Kanban sütunu toplamları ve boyutlandırması.
`calendarLayout`, `calendarFieldMetadataUniversalIdentifier`, `calendarEndFieldMetadataUniversalIdentifier`	`ViewCalendarLayout.DAY` / `WEEK` / `MONTH`	Takvim görünümleri: düzen, kayıtları konumlandıran tarih alanı ve isteğe bağlı bir bitiş tarihi alanı.

Yukarıdaki tüm enum’lar twenty-sdk/define içinden dışa aktarılır.

Filtreler

Bir görünüm, önceden uygulanmış filtrelerle gelebilir. Her filtrenin üç koordinatı vardır: filtrelenen alan, işleç (nasıl karşılaştırılacağı) ve değer (neyle karşılaştırılacağı). Üçünün de hizalı olması gerekir — bir alan türüne uygulanmayan bir işlecin kullanılması, senkronizasyon sırasında reddedilir.

import { ViewFilterOperand } from 'twenty-sdk/define';

filters: [
  {
    universalIdentifier: '...',
    fieldMetadataUniversalIdentifier: STATUS_FIELD_UNIVERSAL_IDENTIFIER,
    operand: ViewFilterOperand.IS,
    value: ['ACTIVE'],
  },
],

Alan türüne göre desteklenen işleçler

Alan tipi	Desteklenen işleçler
`TEXT`, `EMAILS`, `FULL_NAME`, `ADDRESS`, `LINKS`, `PHONES`, `RAW_JSON`, `FILES`, `ACTOR`, `ARRAY`	`CONTAINS`, `DOES_NOT_CONTAIN`, `IS_EMPTY`, `IS_NOT_EMPTY`
`ACTOR.source`, `ACTOR.workspaceMemberId`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`SELECT`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`MULTI_SELECT`	`CONTAINS`, `DOES_NOT_CONTAIN`, `IS_EMPTY`, `IS_NOT_EMPTY`
`RELATION`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`NUMBER`	`IS`, `IS_NOT`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS_EMPTY`, `IS_NOT_EMPTY`
`RATING`	`IS`, `GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS_EMPTY`, `IS_NOT_EMPTY`
`CURRENCY`, `CURRENCY.amountMicros`	`GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`, `IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`CURRENCY.currencyCode`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`DATE`, `DATE_TIME`	`IS`, `IS_RELATIVE`, `IS_IN_PAST`, `IS_IN_FUTURE`, `IS_TODAY`, `IS_BEFORE`, `IS_AFTER`, `IS_EMPTY`, `IS_NOT_EMPTY`
`BOOLEAN`	`IS`
`UUID`	`IS`, `IS_NOT`, `IS_EMPTY`, `IS_NOT_EMPTY`
`TS_VECTOR`	`VECTOR_SEARCH`

Benzer adlara sahip alan türleri tamamen farklı işleçler kullanabilir — buna SELECT ve MULTI_SELECT yaygın bir örnektir.

Her işleç için değer biçimi

value alanı her zaman JSON olarak serileştirilebilir bir değerdir, ancak beklenen biçim işlece bağlıdır:

İşleç ailesi	Değer biçimi	Örnek
`SELECT` üzerinde `IS`, `IS_NOT`	seçenek anahtarları dizisi (metinler)	`['ACTIVE', 'PENDING']`
`MULTI_SELECT` üzerinde `CONTAINS`, `DOES_NOT_CONTAIN`	seçenek anahtarları dizisi (metinler)	`['TAG_A']`
`RELATION` üzerinde `IS`, `IS_NOT`	kayıt kimlikleri dizisi (uuid’ler)	`['c5a1...']`
metin benzeri alanlar üzerinde `CONTAINS`, `DOES_NOT_CONTAIN`	metin	`'acme'`
`NUMBER` üzerinde `IS`, `IS_NOT`	metin (değer)	`'5'`
`RATING` / `UUID` üzerinde `IS`	metin (değer)	`'5'`
`GREATER_THAN_OR_EQUAL`, `LESS_THAN_OR_EQUAL`	metin (sınır)	`'10'`
`DATE` / `DATE_TIME` üzerinde `IS`, `IS_BEFORE`, `IS_AFTER`	ISO 8601 dizesi	`'2025-01-01T00:00:00Z'`
`IS_EMPTY`, `IS_NOT_EMPTY`	boş dize	`''`
`BOOLEAN` üzerinde `IS`	`'true'` veya `'false'`	`'true'`

Görünümlerin kullanıcı arayüzünde görüntülenme şekli

Tek başına bir görünüm, kenar çubuğundan erişilebilir değildir. Orada görünmesini sağlamak için, türü VIEW olan ve görünümün universalIdentifier değerini işaret eden bir navigasyon menüsü öğesi ile eşleştirin. Bu, kanonik desendir: Her özel nesne, oluşturma sırasında otomatik olarak oluşturulan varsayılan bir indeks görünümü alır; dolayısıyla yalnızca onu açan kenar çubuğu öğesini eklemeniz yeterlidir.

Genel Bakış

Uygulamalar

API

Kendi Kendine Barındırma

Katkıda Bulunun

Önemli noktalar

İsteğe bağlı özellikler

Filtreler

Alan türüne göre desteklenen işleçler

Her işleç için değer biçimi

Görünümlerin kullanıcı arayüzünde görüntülenme şekli

​Önemli noktalar

​İsteğe bağlı özellikler

​Filtreler

​Alan türüne göre desteklenen işleçler

​Her işleç için değer biçimi

​Görünümlerin kullanıcı arayüzünde görüntülenme şekli

Önemli noktalar

İsteğe bağlı özellikler

Filtreler

Alan türüne göre desteklenen işleçler

Her işleç için değer biçimi

Görünümlerin kullanıcı arayüzünde görüntülenme şekli