ActiveAdmin-Sortable_Tree 使用手册

ActiveAdmin-Sortable_Tree 使用手册

active_admin-sortable_tree Show ActiveAdmin index as a nested tree with drag'n'drop 项目地址: https://gitcode.com/gh_mirrors/ac/active_admin-sortable_tree

项目概述

本指南旨在提供关于如何使用和理解 active_admin-sortable_tree 开源项目的详细步骤。这个项目主要功能是在 ActiveAdmin 管理界面中展示资源索引为嵌套树状结构，并支持拖拽排序。它适用于基于Ruby on Rails的应用程序，尤其是那些采用ActiveAdmin作为后台管理界面的。

1. 项目目录结构及介绍

active_admin-sortable_tree 的仓库遵循标准的Ruby Gem结构：

- app/assets                # 包含JavaScript和CSS资源供ActiveAdmin集成。
- bin                       # 可执行脚本，如gem命令等。
- docs                      # 项目文档，通常是开发过程中的说明或帮助文档。
- gemfiles                  # 特定版本依赖的示例Gemfile。
- lib                       # 核心代码库，包含主gem逻辑。
- spec                      # 单元测试和规范测试的存放位置。
- vendor                    # 第三方依赖或非标准组件。
- .gitignore                # 忽略版本控制的文件或目录列表。
- Gemfile                   # 项目所需宝石的声明文件。
- MIT-LICENSE               # 许可证文件，本项目使用MIT许可证。
- README.md                 # 项目的主要读我文件，包含快速入门指南。
- Rakefile                  # 定义了项目的rake任务。
- active_admin-sortable_tree.gemspec # Gem规格文件，描述gem的元数据。

2. 项目的启动文件介绍

在实际应用中，不需要直接操作此开源项目本身的启动文件，因为它是作为一个Ruby Gem来使用的。但是，在你的Rails应用程序里，需要进行以下集成步骤以“启动”这个特性：

• Gemfile: 需要在应用的Gemfile中添加以下行并执行bundle install来安装这个gem:

  gem "active_admin-sortable_tree", "~> 2.0.0"
  

• ActiveAdmin配置: 在对应的ActiveAdmin资源定义(app/admin/*)中，你需要启用sortable和可能的树状视图配置，例如：

  ActiveAdmin.register Page do
    sortable tree: true
    index :as => :sortable do
      column :title
      actions
    end
  end
  

• 资产加载: 确保在你的JavaScript (app/assets/javascripts/active_admin.js) 和样式表 (app/assets/stylesheets/active_admin.css) 中引入必要的文件：

  //= require active_admin/sortable
  

  @import "active_admin/sortable";
  

3. 项目的配置文件介绍

active_admin-sortable_tree 不直接提供一个独立的配置文件，其配置是通过ActiveAdmin内部资源定义完成的。然而，你可以通过ActiveAdmin的注册方法来自定义行为，比如设置排序属性、树形结构的行为等。例如：

ActiveAdmin.register Page do
  # 配置参数示例
  sortable tree: true,
           sorting_attribute: :position,
           parent_method: :parent,
           children_method: :children,
           roots_method: :roots,
           roots_collection: proc { |controller| controller.current_user.pages.roots }
end

这些配置允许你微调树状显示和排序逻辑，适应不同的数据库关系模式（如Ancestry或其他树型模型实现）。

此外，虽然没有单独列出的配置文件，但可以通过环境配置（如config/application.rb）来调整是否自动注册资产，以避免ActiveAdmin的弃用警告：

config.aa_sortable_tree.register_assets = false

这样，你就能够通过上述方式对active_admin-sortable_tree进行基本的集成和定制，无需直接编辑该gem的内部文件即可享受到强大的ActiveAdmin索引排序和树状显示功能。

active_admin-sortable_tree Show ActiveAdmin index as a nested tree with drag'n'drop 项目地址: https://gitcode.com/gh_mirrors/ac/active_admin-sortable_tree