Add FOLV info #222

TeterinaSvetlana · 2024-07-22T06:49:14Z

Summary by CodeRabbit

Новые функции
- Обновлена документация для компонента flexberry-objectlistview, добавлены новые свойства для улучшения управления и отображения иерархических данных.
- Введены флаги для настройки иерархического режима и управления внешним видом, включая tableStriped, maxTextLength и cutBySpaces.
- Подробно описаны методы сервиса objectlistview-events для управления записями и фильтрами.
Документация
- Расширены разделы о настройках по умолчанию и примерах использования новых функций.

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

sonarqubecloud · 2024-08-27T20:39:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

coderabbitai · 2024-10-25T07:57:47Z

Walkthrough

Документ компонента flexberry-objectlistview был значительно обновлён, добавив новые функции и свойства, включая флаги для настройки иерархического режима. Введены новые свойства для управления внешним видом и функциональностью компонента, такие как tableStriped, maxTextLength и cutBySpaces. Также подробно описаны методы сервиса objectlistview-events, позволяющие управлять выбранными записями, фильтрами и другими аспектами. Расширена секция с настройками по умолчанию, чтобы обеспечить ясность в поведении компонента.

Changes

Файлы	Изменения
pages/products/flexberry-ember/3.x/components/...ru.md	Добавлены новые свойства: `tableStriped`, `_availableHierarchicalMode`, `disableHierarchicalMode`, `hierarchicalIndent`, `hierarchyPaging`, `hierarchicalAttribute`, `inHierarchicalMode`, `onEditForm`, `maxTextLength`, `cutBySpaces`. Описаны методы сервиса `objectlistview-events` и расширены настройки по умолчанию.

Poem

В мире данных, как в сказке,
Обновлён objectlistview — не в маске!
Новые флаги, цвета в ряд,
Теперь работа — это не ад!
С зайцем вместе мы поём,
В иерархии мы найдём свой дом! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (3)

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md (3)

105-112: Улучшить документацию новых свойств компонента.

Для улучшения читаемости и понимания, предлагаю следующие уточнения в описании свойств:

Для tableStriped добавить пример использования

Для hierarchicalIndent указать допустимый диапазон значений

Для hierarchyPaging добавить пример конфигурации

471-472: Улучшить структуру предложения.

Длинное предложение следует разбить на несколько для улучшения читаемости. Также рекомендуется использовать маркированный список для перечисления необходимых шагов настройки.

271-282: Структурировать документацию сервиса.

Рекомендуется добавить:

Диаграмму взаимодействия сервиса с компонентом

Примеры типичных сценариев использования

Секцию с известными ограничениями

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a12eaf2 and 0d3651b.

📒 Files selected for processing (1)

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md (3 hunks)

🧰 Additional context used

🪛 LanguageTool

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

[misspelling] ~265-~265: «троеточие» — просторечие, исправление: «многоточие»
Context: ...зываться заданное количество символов и троеточие после. Если задать длину 0, то ограниче...

(RU_SIMPLE_REPLACE)

[uncategorized] ~312-~312: Пропущена запятая: «таких, как»
Context: ...с компонентом flexberry-objectlistview, таких как добавление, удаление, выбор и изменение...

(TAKOJ_KAK)

[uncategorized] ~444-~444: Перед знаками препинания не должно быть пробела: «умолчанию:»
Context: ...аткое описание компонента |Значение по умолчанию :-----------------------|:---------------...

(Punct_and_spaces)

coderabbitai · 2024-10-25T07:58:57Z

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

+}
+```
+
+Длина текста `maxTextLength`задается в символах. Если содержимое ячейки не влезает в указанную длину, то будет показываться заданное количество символов и троеточие после. Если задать длину 0, то ограничение длины отключено. По умолчанию равно 0.


⚠️ Potential issue

Исправить просторечие в тексте.

Заменить слово "троеточие" на литературное "многоточие".

🧰 Tools

🪛 LanguageTool

[misspelling] ~265-~265: «троеточие» — просторечие, исправление: «многоточие»
Context: ...зываться заданное количество символов и троеточие после. Если задать длину 0, то ограниче...

(RU_SIMPLE_REPLACE)

coderabbitai · 2024-10-25T07:58:57Z

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

+    let filters = this.get('objectlistviewEvents').getOlvFilterColumnsArray('myOlvComponentName');
+  ```
+
+* Триггеры событий: Сервис предоставляет множество методов для генерации различных событий, связанных с компонентом flexberry-objectlistview, таких как добавление, удаление, выбор и изменение записей, применение фильтров, обновление списка и т.д. Примеры использования:


⚠️ Potential issue

Добавить пропущенную запятую.

Необходимо добавить запятую в конструкции "таких, как".

🧰 Tools

🪛 LanguageTool

[uncategorized] ~312-~312: Пропущена запятая: «таких, как»
Context: ...с компонентом flexberry-objectlistview, таких как добавление, удаление, выбор и изменение...

(TAKOJ_KAK)

coderabbitai · 2024-10-25T07:58:57Z

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

+
+Атрибуты, влияющие на настройку иерархии:
+
+Наименование компонента |Краткое описание компонента  |Значение по умолчанию


⚠️ Potential issue

Исправить форматирование таблицы.

Удалить лишний пробел перед двоеточием в заголовке "Значение по умолчанию".

🧰 Tools

🪛 LanguageTool

[uncategorized] ~444-~444: Перед знаками препинания не должно быть пробела: «умолчанию:»
Context: ...аткое описание компонента |Значение по умолчанию :-----------------------|:---------------...

(Punct_and_spaces)

coderabbitai · 2024-10-25T07:58:57Z

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md

+Для спискового объекта есть возможность задать отображение иерархий (когда у детейла есть детейл). Примеры есть на тестовом стенде:
+
+* [Пример иерархии на списке](https://flexberry.github.io/ember-flexberry/dummy/dummy-test-2/#/components-examples/flexberry-objectlistview/hierarchy-example)
+* [Пример иерархии c пейджингом на списке](https://flexberry.github.io/ember-flexberry/dummy/dummy-test-2/#/components-examples/flexberry-objectlistview/hierarchy-paging-example).
+


🛠️ Refactor suggestion

Дополнить описание иерархического режима.

Рекомендуется добавить:

Краткое описание принципа работы иерархического режима

Ограничения при использовании

Примеры типичных сценариев использования

Add FOLV info

ee8aa06

pepelyaeva reviewed Aug 19, 2024

View reviewed changes

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md Outdated Show resolved Hide resolved

pepelyaeva reviewed Aug 19, 2024

View reviewed changes

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md Show resolved Hide resolved

pepelyaeva reviewed Aug 19, 2024

View reviewed changes

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md Show resolved Hide resolved

pepelyaeva reviewed Aug 19, 2024

View reviewed changes

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md Show resolved Hide resolved

pepelyaeva reviewed Aug 19, 2024

View reviewed changes

pages/products/flexberry-ember/3.x/components/efd3_object-list-view.ru.md Outdated Show resolved Hide resolved

Nasutya reviewed Aug 20, 2024

View reviewed changes

code review

0d3651b

TeterinaSvetlana requested review from Nasutya and pepelyaeva October 25, 2024 07:56

TeterinaSvetlana added need review ready to merge labels Oct 25, 2024

coderabbitai bot reviewed Oct 25, 2024

View reviewed changes


		Атрибуты, влияющие на настройку иерархии:

		Наименование компонента \|Краткое описание компонента \|Значение по умолчанию

Add FOLV info #222

Are you sure you want to change the base?

Add FOLV info #222

Uh oh!

Conversation

TeterinaSvetlana commented Jul 22, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Aug 27, 2024

Quality Gate passed

Uh oh!

coderabbitai bot commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

TeterinaSvetlana commented Jul 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 25, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)