التنسيقات الأساسية

Canonical layouts are proven, versatile layouts that provide an optimal user experience on a variety of form factors.

The canonical layouts support small screen phones as well as tablets, foldables, and ChromeOS devices. Derived from Material Design guidance, the layouts are aesthetic as well as functional.

The Android framework includes specialized components that make implementation of the layouts straightforward and reliable.

The canonical layouts create engaging, productivity‑enhancing UIs that form the foundation of great apps.

List-detail

The list-detail layout enables users to explore lists of items that have descriptive, explanatory, or other supplementary information—the item detail.

The layout divides the app window into two side-by-side panes: one for the list, one for the detail. Users select items from the list to display the item detail. Deep links in the detail reveal additional content in the detail pane.

Expanded-width displays (see Use window size classes) accommodate both the list and detail at the same time. Selection of a list item updates the detail pane to show the related content for the selected item.

Medium- and compact-width displays show either the list or the detail, depending on user interaction with the app. When just the list is visible, selection of a list item displays the detail in place of the list. When just the detail is visible, pressing the back button redisplays the list.

Configuration changes such as device orientation changes or app window size changes can change the display's window size class. A list‑detail layout responds accordingly, preserving app state:

• If an expanded-width display showing both the list and detail panes narrows to medium or compact, the detail pane remains visible and the list pane is hidden
• If a medium- or compact-width display has just the detail pane visible and the window size class widens to expanded, the list and detail are shown together, and the list indicates that the item corresponding to the content in the detail pane is selected
• If a medium- or compact-width display has just the list pane visible and widens to expanded, the list and a placeholder detail pane are shown together

List-detail is ideal for messaging apps, contact managers, interactive media browsers or any app where the content can be organized as a list of items that reveal additional information.

Implementation

يتيح النموذج التصريحي في Compose منطق فئة حجم النافذة الذي يحدّد ما إذا كان سيتم عرض لوحتَي القائمة والتفاصيل في الوقت نفسه (عندما تكون فئة حجم النافذة الموسّعة) أو لوحة القائمة أو التفاصيل فقط (عندما تكون فئة حجم النافذة متوسطة أو صغيرة).

لضمان تدفّق البيانات في اتجاه واحد، ارفع مستوى جميع الحالات، بما في ذلك فئة حجم النافذة الحالية وتفاصيل عنصر القائمة المحدّد (إن وُجد)، حتى تتمكّن جميع العناصر القابلة للإنشاء من الوصول إلى البيانات وعرضها بشكل صحيح.

عند عرض لوحة التفاصيل فقط على أحجام النوافذ الصغيرة، أضِف BackHandler لإزالة لوحة التفاصيل وعرض لوحة القائمة فقط. لا يشكّل BackHandler جزءًا من التنقّل العام في التطبيق لأنّ المعالج يعتمد على فئة حجم النافذة وحالة التفاصيل المحدّدة.

‫ListDetailPaneScaffold هي دالة قابلة للإنشاء ذات مستوى عالٍ تبسّط عملية تنفيذ عرض على شكل قائمة مع تفاصيل. ويتعامل تلقائيًا مع منطق اللوحة استنادًا إلى فئات حجم النافذة ويتيح التنقّل بين اللوحات.

في ما يلي عملية تنفيذ بسيطة باستخدام ListDetailPaneScaffold:

@OptIn(ExperimentalMaterial3AdaptiveApi::class)
@Composable
fun MyListDetailPaneScaffold() {
    val navigator = rememberListDetailPaneScaffoldNavigator()
    ListDetailPaneScaffold(
        directive = navigator.scaffoldDirective,
        value = navigator.scaffoldValue,
        listPane = {
            // Listing Pane
        },
        detailPane = {
            // Details Pane
        }
    )
}
CanonicalLayoutSamples.kt

في ما يلي المكوّنات الرئيسية في هذا المثال:

• rememberListDetailPaneScaffoldNavigator: تنشئ أداة تنقّل لإدارة التنقّل بين لوحتي القائمة والتفاصيل.
• ‫listPane: تعرض هذه السمة قائمة بالسلع.
• ‫detailPane: تعرض هذه السمة محتوى عنصر محدّد.

للاطّلاع على أمثلة تفصيلية حول التنفيذ، يُرجى مراجعة:

• دليل المطوّر إنشاء عرض على شكل قائمة مع تفاصيل
• نموذج list-detail-compose

Feed

A feed layout arranges equivalent content elements in a configurable grid for quick, convenient viewing of a large amount of content.

Size and position establish relationships among the content elements.

Content groups are created by making elements the same size and positioning them together. Attention is drawn to elements by making them larger than nearby elements.

Cards and lists are common components of feed layouts.

A feed layout supports displays of almost any size because the grid can adapt from a single, scrolling column to a multi‑column scrolling feed of content.

Feeds are especially well suited for news and social media apps.

Implementation

A feed consists of a large number of content elements in a vertical scrolling container laid out in a grid. Lazy lists efficiently render a large number of items in columns or rows. Lazy grids render items in grids, supporting configuration of the item sizes and spans.

Configure the columns of the grid layout based on the available display area to set the minimum allowable width for grid items. When defining grid items, adjust column spans to emphasize some items over others.

For section headers, dividers, or other items designed to occupy the full width of the feed, use maxLineSpan to take up the full width of the layout.

On compact-width displays that don't have enough space to show more than one column, LazyVerticalGrid behaves just like a LazyColumn.

Here is a minimal implementation using LazyVerticalGrid:

@Composable
fun MyFeed(names: List<String>) {
    LazyVerticalGrid(
        // GridCells.Adaptive automatically adapts column count based on available width
        columns = GridCells.Adaptive(minSize = 180.dp),
    ) {
        items(names) { name ->
            Text(name)
        }
    }
}
CanonicalLayoutSamples.kt

The key to an adaptive feed is the columns configuration. GridCells.Adaptive(minSize = 180.dp) creates a grid where each column is at least 180.dp wide. The grid then displays as many columns as can fit in the available space.

For an example implementation, see the Feed with Compose sample.

Supporting pane

Supporting pane layout organizes app content into primary and secondary display areas.

The primary display area occupies the majority of the app window (typically about two thirds) and contains the main content. The secondary display area is a pane that takes up the remainder of the app window and presents content that supports the main content.

Supporting pane layouts work well on expanded-width displays (see Use window size classes) in landscape orientation. Medium- or compact‑width displays support showing both the primary and secondary display areas if the content is adaptable to narrower display spaces, or if the additional content can be initially hidden in a bottom or side sheet accessible by means of a control such as a menu or button.

A supporting pane layout differs from a list‑detail layout in the relationship of the primary and secondary content. Secondary pane content is meaningful only in relation to the primary content; for example, a supporting pane tool window is irrelevant by itself. The supplementary content in the detail pane of a list‑detail layout, however, is meaningful even without the primary content, for example, the description of a product from a product listing.

Use cases for supporting pane include:

• Productivity apps: A document or spreadsheet accompanied by reviewer comments in a supporting pane
• Media apps: A streaming video and a list of related videos in a supporting pane, or the depiction of an album of music supplemented with a playlist
• Tools and settings: A media editing tool with palettes, effects, and other settings in a support pane

Implementation

تتيح Compose منطق فئة حجم النافذة، ما يتيح لك تحديد ما إذا كنت تريد عرض المحتوى الرئيسي والمحتوى الداعم في الوقت نفسه أو وضع المحتوى الداعم في مكان بديل.

ارفع مستوى جميع الحالات، بما في ذلك فئة حجم النافذة الحالية والمعلومات ذات الصلة بالبيانات في المحتوى الرئيسي والمحتوى الداعم.

بالنسبة إلى الشاشات ذات العرض المضغوط، ضَع المحتوى الداعم أسفل المحتوى الرئيسي أو داخل ورقة في أسفل الشاشة. بالنسبة إلى العروض المتوسطة والموسّعة، ضَع المحتوى الثانوي بجانب المحتوى الرئيسي، مع ضبط حجمه بشكل مناسب استنادًا إلى المحتوى والمساحة المتاحة. بالنسبة إلى العرض المتوسط، قسِّم مساحة العرض بالتساوي بين المحتوى الرئيسي والمحتوى الداعم. بالنسبة إلى العرض الموسّع، خصِّص 70% من المساحة للمحتوى الرئيسي و30% للمحتوى الداعم.

‫SupportingPaneScaffold هي دالة برمجية قابلة للإنشاء عالية المستوى تبسّط عملية تنفيذ تنسيقات اللوحات المتجاورة. يتعامل العنصر القابل للإنشاء تلقائيًا مع منطق اللوحة استنادًا إلى فئات حجم النافذة، ويعرض اللوحات جنبًا إلى جنب على الشاشات الكبيرة أو يخفي اللوحة الثانوية على الشاشات الصغيرة. يتيح لك SupportingPaneScaffold أيضًا التنقّل بين اللوحات.

في ما يلي عملية تنفيذ بسيطة:

@OptIn(ExperimentalMaterial3AdaptiveApi::class)
@Composable
fun MySupportingPaneScaffold() {
    // Creates and remembers a navigator to control pane visibility and navigation
    val navigator = rememberSupportingPaneScaffoldNavigator()
    SupportingPaneScaffold(
        // Directive and value help control pane visibility based on screen size and state
        directive = navigator.scaffoldDirective,
        value = navigator.scaffoldValue,
        mainPane = {
            // Main Pane for the primary content
        },
        supportingPane = {
            //Supporting Pane for supplementary content
        }
    )
}
CanonicalLayoutSamples.kt

• rememberSupportingPaneScaffoldNavigator: عنصر قابل للإنشاء ينشئ أداة تنقّل لإدارة إمكانية ظهور اللوحة (على سبيل المثال، إخفاء اللوحة الثانوية أو عرضها على الشاشات الصغيرة)
• ‫mainPane: دالة مركّبة تعرض المحتوى الأساسي
• ‫supportingPane: عنصر مركّب يعرض المحتوى التكميلي

للاطّلاع على أمثلة تفصيلية حول التنفيذ، يُرجى مراجعة:

• دليل المطوّرين حول إنشاء تخطيط لوحة داعمة
• نموذج supporting-pane-compose

Additional resources

• Material Design — Canonical layouts