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

Table of Contents - Sub-items #492

Open
dan-bowerman opened this issue Oct 22, 2024 · 3 comments · May be fixed by #520
Open

Table of Contents - Sub-items #492

dan-bowerman opened this issue Oct 22, 2024 · 3 comments · May be fixed by #520
Assignees
Labels
Content Collection Culling and collating information and assets from existing products Needs: estimate Give this issue an estimate before it's assigned! Storylines Design Work surrounding the appearance and layout of the Storylines product Storylines Viewer Work surrounding the Storylines Viewer that loads individual StoryRAMP products

Comments

@dan-bowerman
Copy link
Member

From the TCEI UX Review - a feature that could be useful for TCEI and future Storylines products.

Description

In a vertical OR horizontal ToC, it would be nice to specify a sub-heading or indentation, to let a user know a section has sub-sections within it.

From the UX review mockups:
image

For a vertical ToC, it could look like this (forgive the crude photoshop):
image

Is your feature request related to a problem?

TCEI has a section called "Project Summaries", and they will have 4-10 projects contained within this section. It would be really nice if the user could jump to those individual projects quickly, through a sub-menu or indented view.

A "sub-item" should correspond with an existing slide in the Storylines product.

@dan-bowerman dan-bowerman added Storylines Design Work surrounding the appearance and layout of the Storylines product Storylines Viewer Work surrounding the Storylines Viewer that loads individual StoryRAMP products Content Collection Culling and collating information and assets from existing products Needs: estimate Give this issue an estimate before it's assigned! labels Oct 22, 2024
@dan-bowerman
Copy link
Member Author

This has renewed interest and may get leveraged in a few projects, TCEI being the primary.

Sub-items would be linked to a parent ToC item.
In a horizontal ToC sub-items would appear as a dropdown item. In a vertical ToC, there would be indentation.

@dan-bowerman
Copy link
Member Author

My strongest preference is not not break backwards compatibility with existing products. Please share your thoughts on how we can cleanly implement this, if possible.

@yileifeng
Copy link
Member

Idea of possible schema structure to support custom table of contents:

"tableOfContents": [
        {
            "title": "TCEI Project Summaries",
            "slideIndex": 0,
            "sublist": [
                {
                    "title": "Item 1",
                    "slideIndex": 1
                },
                {
                    "title": "Item 2",
                    "slideIndex": 2
                }
            ]
        },
        {
            "title": "Community Directory",
            "slideIndex": 3,
            "sublist": []
        }, 
        ...
    ],

This would be a config property on the root level. If specified in the config, we can construct the table of contents entirely based on the provided config structure (needs code verification). Otherwise, we will just default to the current table of contents using the slide-specific ToC toggle flag so backwards compatibility is all good.

@yileifeng yileifeng self-assigned this Dec 6, 2024
@yileifeng yileifeng linked a pull request Dec 18, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Collection Culling and collating information and assets from existing products Needs: estimate Give this issue an estimate before it's assigned! Storylines Design Work surrounding the appearance and layout of the Storylines product Storylines Viewer Work surrounding the Storylines Viewer that loads individual StoryRAMP products
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants