Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 docs(Pagination): add example for MiniVariant property #2075

Merged
merged 3 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<div class="text-center">
<MPagination @bind-Value="_page"
MiniVariant
Length="6">
</MPagination>
</div>

@code{
private int _page = 1;
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
"nextIcon": "Specify the icon to use for the next icon",
"prevIcon": "Specify the icon to use for the prev icon",
"totalVisible": "Specify the max total visible pagination numbers",
"value": "Current selected page"
"value": "Current selected page",
"miniVariant": "Use the mini variant",
"mobileBreakpoint": "Specify the breakpoint at which the mini variant should be applied, default is 600px"
},
"events": {
"onInput": "The updated bound model",
"onNext": "Emitted when going to next item",
"onPrevious": "Emitted when going to previous item"
"onPrevious": "Emitted when going to previous item",
"miniVariantChanged": "Emitted when the mini variant changes"
},
"contents": {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@
"nextIcon": "指定用于下一个图标的图标",
"prevIcon": "指定用于上一个图标的图标",
"totalVisible": "指定最大可见分页数",
"value": "当前选定页面"
"value": "当前选定页面",
"miniVariant": "使用迷你变体",
"mobileBreakpoint": "指定迷你变体应用时的断点,默认为 600px"
},
"events": {
"onInput": "被绑定模型的更新",
"onNext": "转到下一个项目时发出",
"onPrevious": "转到上一个项目时发出"
"onPrevious": "转到上一个项目时发出",
"miniVariantChanged": "当迷你变体更改时触发"
},
"contents": {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,14 @@ Use the `Length` property to set the length of **MPagination**. If the number of

<masa-example file="Examples.components.paginations.Length"></masa-example>

#### Mini variant {released-on=v1.7.0}

By default, when the browser window is less than *600px*, the mini style is automatically used. Use the `MinVariant` property to set the mini style of the pagination.

<masa-example file="Examples.components.paginations.MiniVariant"></masa-example>

#### TotalVisible

You can also manually set the maximum number of visible pages through the `TotalVisible` property.

<masa-example file="Examples.components.paginations.TotalVisible"></masa-example>
<masa-example file="Examples.components.paginations.TotalVisible"></masa-example>
26 changes: 16 additions & 10 deletions docs/Masa.Blazor.Docs/wwwroot/pages/components/paginations/zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,54 @@ related:
- /blazor/components/lists
---

## 使用
## 使用 {#usage}

分页默认根据设置的 `Length` 属性显示页数,两边有 `Prev` 和 `Next` 按钮帮助导航。

<masa-example file="Examples.components.paginations.Usage"></masa-example>

## 示例
## 示例 {#examples}

### 属性
### 属性 {#props}

#### 圆形
#### 圆形 {#circle}

`Circle` 属性为你提供了分页按钮的另一种样式。

<masa-example file="Examples.components.paginations.Circle"></masa-example>

#### 禁用
#### 禁用 {#disabled}

使用 `Disabled` 属性,可以手动禁用分页。

<masa-example file="Examples.components.paginations.Disabled"></masa-example>

#### Href 格式 {released-on=v1.3.0}
#### Href 格式 {#href-format released-on=v1.3.0}

使用 `HrefFormat` 属性,可以自定义分页按钮的链接格式,这对 SEO 有帮助。

<masa-example file="Examples.components.paginations.HrefFormat"></masa-example>

#### 图标
#### 图标 {#icon}

上一页和下一页的图标可以通过 `PrevIcon` 和 `NextIcon` 属性自定义。

<masa-example file="Examples.components.paginations.Icon"></masa-example>

#### 长度
#### 长度 {#length}

使用 `Length` 属性可以设置 **MPagination** 的长度,如果页面按钮的数量超过了父容器,分页将被从中截断。

<masa-example file="Examples.components.paginations.Length"></masa-example>

#### 最大可见分页数
#### 迷你 {#mini-variant released-on=v1.7.0}

默认情况下,当浏览器窗口小于 *600px* 时,会自动使用迷你样式。你也可以使用 `MinVariant` 属性可以手动设置迷你样式。

<masa-example file="Examples.components.paginations.MiniVariant"></masa-example>

#### 最大可见分页数 {#totalvisible}

你也可以通过 `TotalVisible` 属性手动设置最大可见分页数。

<masa-example file="Examples.components.paginations.TotalVisible"></masa-example>
<masa-example file="Examples.components.paginations.TotalVisible"></masa-example>
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Upgrade Guides

## Upgrading form v1.6.x to v1.7.0

### Components

#### Pagination

A mini style UI has been added, now when the browser window is less than *600px*, it will automatically use it. If you don't want to use the mini style, you can manually set it through the `MiniVariant` property.

```diff
<MPagination @bind-Value="page"
Length="10"
+ MiniVariant="false"
></MPagination>
```

## Upgrading form v1.5.x to v1.6.0

### Change the script
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# 升级指南

## 从 v1.6.x 升级到 v1.7.0 {#upgrading-from-v1-6-x-to-v1-7-0}

### 组件 {#components}

#### Pagination

新增了一个迷你样式的UI,现在当浏览器窗口小于 *600px* 时,会自动使用。如果不想使用迷你样式,可以通过 `MiniVariant` 属性手动设置。

```diff
<MPagination @bind-Value="page"
Length="10"
+ MiniVariant="false"
></MPagination>
```

## 从 v1.5.x 升级到 v1.6.0

### 更改脚本
Expand Down
6 changes: 4 additions & 2 deletions src/Masa.Blazor/Components/Pagination/MPagination.razor
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@
@inherits MasaComponentBase

<CascadingValue Value="IsDark" Name="IsDark">
<nav id="@Id" @ref="Ref" class="@Class" style="@Style" @attributes="@Attributes">
<nav id="@Id" @ref="Ref" class="@Class" style="@Style"
role="navigation"
@attributes="@Attributes">
<ul class="@_modifierBuilder.Add(Circle).Add(Disabled).AddTheme(IsDark, IndependentTheme)">
@GenPaginationIcon(PaginationIconType.First)

@if (_internalMiniVariant)
{
<div class="m-pagination__mini">
<span class="m-pagination__current">@Value</span>
<span class="m-pagination__separator">/</span>
<span class="m-pagination__slash">/</span>
<span class="m-pagination__total">@Length</span>
</div>
}
Expand Down
4 changes: 4 additions & 0 deletions src/Masa.Blazor/wwwroot/css/masa-blazor.extend.css
Original file line number Diff line number Diff line change
Expand Up @@ -1472,6 +1472,10 @@ a.m-pagination__item {
text-align: center;
}

.m-pagination__slash {
margin: 0 8px;
}

/* InteractiveTrigger */

.m-interactive-trigger {
Expand Down
2 changes: 1 addition & 1 deletion src/Masa.Blazor/wwwroot/css/masa-blazor.min.css

Large diffs are not rendered by default.

Loading