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.

Sign up for GitHub

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

Jump to bottom

Implement POC for theme default options #434

Closed
humitos opened this issue Nov 14, 2024 · 0 comments · Fixed by #482
Closed

Implement POC for theme default options #434

humitos opened this issue Nov 14, 2024 · 0 comments · Fixed by #482
Assignees
@humitos

Comments

@humitos
Copy link
Member

humitos commented Nov 14, 2024

I'm creating a small issue to track the progress of the work we discussed in;
@humitos humitos self-assigned this Nov 14, 2024
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Nov 14, 2024
humitos added a commit that referenced this issue Jan 8, 2025
@humitos
Flyout: use theme default for position
39d26d3 
Initial POC to prove if this idea is possible and how we feel about it.

* Related #51
* Closes #434
humitos added a commit to readthedocs/readthedocs.org that referenced this issue Jan 8, 2025
@humitos
Addons: allow to set a "Default" or a explicit position for flyout
6c95c2a 
- Add a new `flyout_position` field to the `AddonsConfig` model
- Show the field in the form
- Return the field in the APIv3 to be consumed by the frontend

* Related readthedocs/addons#434
humitos added a commit to readthedocs/readthedocs.org that referenced this issue Jan 8, 2025
@humitos
Addons: allow to set a "Default" or a explicit position for flyout
6af5f85 
- Add a new `flyout_position` field to the `AddonsConfig` model
- Show the field in the form
- Return the field in the APIv3 to be consumed by the frontend

* Related readthedocs/addons#434
humitos added a commit to readthedocs/ext-theme that referenced this issue Jan 8, 2025
@humitos
Addons: add "flyout position" to the form
9a78c37 
Required by readthedocs/addons#434
This was referenced Jan 8, 2025
Merged
Merged
Merged
@humitos humitos moved this from Planned to Needs review in 📍Roadmap Jan 8, 2025
humitos added a commit to readthedocs/readthedocs.org that referenced this issue Jan 14, 2025
@humitos
Addons: allow to set a "Default" or a explicit position for flyout (#…
e70cf31 
…11891)

- Add a new `flyout_position` field to the `AddonsConfig` model
- Show the field in the form
- Return the field in the APIv3 to be consumed by the frontend

----

* Related readthedocs/addons#434
humitos added a commit to readthedocs/ext-theme that referenced this issue Jan 14, 2025
@humitos
Addons: add "flyout position" to the form (#554)
6da3d15 
Required by readthedocs/addons#434
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Jan 14, 2025
humitos added a commit that referenced this issue Jan 22, 2025
@humitos
Flyout: use theme default for position (#482)
24287b8 
Initial POC to prove if this idea is possible and how we feel about it.

I put together an example of what I understand we want to build here 😅 .
In this example, the theme author will make explicitly how they want to
use `readthedocs-flyout` HTML tag:

```html
<readthedocs-flyout position="top-right"></readthedocs-flyout>
```

That will add the class `top-right` and show the flyout as follows:


![Screenshot_2025-01-08_12-44-20](https://github.com/user-attachments/assets/14ed7946-a1ab-4c44-84dc-d2a9ee456b8c)

However, the project author can change the `position` value from the
dashboard if they prefer to override the theme's default value:


![Peek 2025-01-08
12-46](https://github.com/user-attachments/assets/d8ab340b-2fc1-4704-ac0e-4a12bfe0ae07)

* Related #51
* Requires readthedocs/ext-theme#554
* Requires readthedocs/readthedocs.org#11891
* Example using
https://test-builds.readthedocs.io/en/addons-theme-defaults/
* Closes #434
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
None yet
Projects
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Flyout: use theme default for position readthedocs/addons
1 participant
@humitos