Description

Clips image of BoxDecoration to circle when shape is BoxShape.circular.

Current behavior is the image is clipped to an oval. Dimensions of this oval are tightly constrained by the size of the decorated widget.

Before

After

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatelessWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(title),
      ),
      body: Container(
        height: double.infinity,
        width: double.infinity,
        decoration: BoxDecoration(
          shape: BoxShape.circle,
          color: Colors.red,
          image: DecorationImage(
            fit: BoxFit.cover,
            image: AssetImage('assets/logo_flutter.png'),
          ),
        ),
      ),
    );
  }
}

See more in the related issue.

Also, I changed Boxdecoration.getClipPath() to reflect changes in clipping behavior.

Related Issues

Fixes #63351

Tests

I added a test for Boxdecoration.getClipPath() for the case when shape of Box decoration is BoxShape.circle.

https://github.com/timekone/flutter/blob/84594a2dbdfa5d1e3156c9b649c82ae5b8bdd488/packages/flutter/test/painting/box_decoration_test.dart#L88-L99

Checklist

Before you create this PR, confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I signed the CLA.
• I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
• I read the Tree Hygiene wiki page, which explains my responsibilities.
• I updated/added relevant documentation (doc comments with ///).
• All existing and new tests are passing.
• The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
• I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

• No, no existing tests failed, so this is not a breaking change.