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

Experimental Feature: New ImageBlock for StreamField (Work in Progress) #11791

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

Chiemezuo
Copy link
Contributor

@Chiemezuo Chiemezuo commented Mar 24, 2024

This is an experimental feature I'm demoing for my GSoC proposal.
It is a new StreamField block called ImageBlock.
It's a work in progress, but I'd like it to form a basis for my potential conversations about the 'alt text project' with mentors @Stormheg @SaptakS and @thibaudcolas

This is a sample of what the ImageBlock would look like:
image

And this is what a sample of what it would look like from the console output:
image

Copy link

squash-labs bot commented Mar 24, 2024

Manage this branch in Squash

Test this branch here: https://chiemezuofeatureexperimental-i-v7p7b.squash.io

@gasman gasman changed the title Experimental Feature: New StreamBlock (Work in Progress) Experimental Feature: New ImageBlock for StreamField (Work in Progress) Apr 17, 2024
@Chiemezuo Chiemezuo force-pushed the feature/experimental-image-block branch from 4e3ebe6 to b6d78de Compare May 21, 2024 22:19
Copy link
Member

@Stormheg Stormheg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have yet to try this out on a Wagtail installation, but this is already looks amazing to me! Good work 👍

@Chiemezuo
Copy link
Contributor Author

Thank you, @Stormheg :)

Comment on lines +119 to +121
# Use assertRaises as a context manager to check if a ValidationError is raised
with self.assertRaises(StructBlockValidationError) as context:
block.clean(block.to_python(value))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Use assertRaises as a context manager to check if a ValidationError is raised
with self.assertRaises(StructBlockValidationError) as context:
block.clean(block.to_python(value))
# No alt text is given and the image is not marked decorative, this is an invalid state and should raise an error
with self.assertRaises(StructBlockValidationError) as context:
block.clean(block.to_python(value))

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tip: don't explain what the code is doing. Instead, explain why it is doing something.

In this instance: why are we expecting an exception to be raised.

Comment on lines +133 to +134
# Use assertRaises as a context manager to check if a ValidationError is raised
with self.assertRaises(StructBlockValidationError) as context:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto the above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants